Package org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl

Class PropertyMappingAnnotationProcessorContextImpl

java.lang.Object

org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.AbstractMappingAnnotationProcessorContext

org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.PropertyMappingAnnotationProcessorContextImpl

All Implemented Interfaces:

MappingAnnotatedElement, MappingAnnotatedProperty, MappingAnnotationProcessorContext, PropertyMappingAnnotationProcessorContext

public class PropertyMappingAnnotationProcessorContextImpl
extends AbstractMappingAnnotationProcessorContext
implements PropertyMappingAnnotationProcessorContext, MappingAnnotatedProperty

Field Summary

Fields inherited from class org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.AbstractMappingAnnotationProcessorContext

annotationHelper

Constructor Summary

Constructors

Constructor	Description
PropertyMappingAnnotationProcessorContextImpl(PojoRawTypeModel<?> typeModel, PojoPropertyModel<?> propertyModel, Annotation annotation, AnnotationHelper annotationHelper, PojoMappingConfigurationContext configurationContext)

Method Summary

Modifier and Type	Method	Description
Stream<Annotation>	allAnnotations()
MappingAnnotatedProperty	annotatedElement()
EventContext	eventContext()
Class<?>	javaClass()
Optional<Class<?>>	javaClass(ContainerExtractorPath extractorPath)
String	name()

Methods inherited from class org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.AbstractMappingAnnotationProcessorContext

toBeanReference, toContainerExtractorPath, toNullIfDefault, toPojoModelPathValueNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.MappingAnnotationProcessorContext

toBeanReference, toBeanReference, toContainerExtractorPath, toMap, toNullIfDefault, toPojoModelPathValueNode

Constructor Details

PropertyMappingAnnotationProcessorContextImpl

public PropertyMappingAnnotationProcessorContextImpl(PojoRawTypeModel<?> typeModel,
 PojoPropertyModel<?> propertyModel,
 Annotation annotation,
 AnnotationHelper annotationHelper,
 PojoMappingConfigurationContext configurationContext)

Method Details

annotatedElement

public MappingAnnotatedProperty annotatedElement()

Specified by:

annotatedElement in interface MappingAnnotationProcessorContext

Specified by:

annotatedElement in interface PropertyMappingAnnotationProcessorContext

Returns:

A representation of the annotated element.

eventContext

public EventContext eventContext()

Specified by:

eventContext in interface MappingAnnotationProcessorContext

Returns:

An event context describing the annotation being processed and its location, for use in log messages and exception messages.

javaClass

public Class<?> javaClass()

Specified by:

javaClass in interface MappingAnnotatedElement

Returns:

The Java class corresponding to the raw type of the annotated element.

javaClass

public Optional<Class<?>> javaClass(ContainerExtractorPath extractorPath)

Specified by:

javaClass in interface MappingAnnotatedProperty

Parameters:

extractorPath - A container extractor path, possibly just ContainerExtractorPath.defaultExtractors().

Returns:

The raw type of values one would obtain by using the given container extractor path to extract values from this property, or Optional.empty() if the container extractor path cannot be applied.

name

public String name()

Specified by:

name in interface MappingAnnotatedProperty

Returns:

The name of the annotated property. In the case of a getter method, the name does not include the "get" prefix and the first character is lowercased.

allAnnotations

public Stream<Annotation> allAnnotations()

Specified by:

allAnnotations in interface MappingAnnotatedElement

Returns:

All annotations declared on the annotated element.