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

Class AbstractMappingAnnotationProcessorContext

java.lang.Object

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

All Implemented Interfaces:

MappingAnnotationProcessorContext

Direct Known Subclasses:

ConstructorMappingAnnotationProcessorContextImpl, MethodParameterMappingAnnotationProcessorContextImpl, PropertyMappingAnnotationProcessorContextImpl, TypeMappingAnnotationProcessorContextImpl

public abstract class AbstractMappingAnnotationProcessorContext
extends Object
implements MappingAnnotationProcessorContext

Field Summary

Fields

Modifier and Type	Field	Description
protected AnnotationHelper	annotationHelper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMappingAnnotationProcessorContext(AnnotationHelper annotationHelper)

Method Summary

Modifier and Type	Method	Description
<T> Optional<BeanReference<? extends T>>	toBeanReference(Class<T> expectedType, Class<?> undefinedTypeMarker, Class<? extends T> type, String name, BeanRetrieval retrieval)	Convert attributes of a bean-reference annotation, such as ValueBridgeRef, to an actual BeanReference.
ContainerExtractorPath	toContainerExtractorPath(ContainerExtraction extraction)	Convert a ContainerExtraction annotation to a ContainerExtractorPath.
<T> T	toNullIfDefault(T value, T defaultValue)
Optional<PojoModelPathValueNode>	toPojoModelPathValueNode(ObjectPath objectPath)	Convert an ObjectPath annotation to a PojoModelPathValueNode.

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

annotatedElement, eventContext, toBeanReference, toMap

Field Detail

annotationHelper

protected final AnnotationHelper annotationHelper

Constructor Detail

AbstractMappingAnnotationProcessorContext

protected AbstractMappingAnnotationProcessorContext(AnnotationHelper annotationHelper)

Method Detail

toPojoModelPathValueNode

public Optional<PojoModelPathValueNode> toPojoModelPathValueNode(ObjectPath objectPath)

Description copied from interface: MappingAnnotationProcessorContext

Convert an ObjectPath annotation to a PojoModelPathValueNode.

Specified by:

toPojoModelPathValueNode in interface MappingAnnotationProcessorContext

Parameters:

objectPath - The annotation to convert.

Returns:

The corresponding path, or an empty optional if the path was empty.

toContainerExtractorPath

public ContainerExtractorPath toContainerExtractorPath(ContainerExtraction extraction)

Description copied from interface: MappingAnnotationProcessorContext

Convert a ContainerExtraction annotation to a ContainerExtractorPath.

Specified by:

toContainerExtractorPath in interface MappingAnnotationProcessorContext

Parameters:

extraction - The annotation to convert.

Returns:

The corresponding path.

toBeanReference

public <T> Optional<BeanReference<? extends T>> toBeanReference(Class<T> expectedType,
                                                                Class<?> undefinedTypeMarker,
                                                                Class<? extends T> type,
                                                                String name,
                                                                BeanRetrieval retrieval)

Description copied from interface: MappingAnnotationProcessorContext

Convert attributes of a bean-reference annotation, such as ValueBridgeRef, to an actual BeanReference.

Example of use:

     Optional<BeanReference<? extends ValueBridge>> valueBridgeRef = toBeanReference(
             ValueBridge.class,
             ValueBridgeRef.UndefinedBridgeImplementationType.class,
             myValueBridgeRefInstance.type(),
             myValueBridgeRefInstance.name(),
             myValueBridgeRefInstance.retrieval()
     );
 

Specified by:

toBeanReference in interface MappingAnnotationProcessorContext

Type Parameters:

T - The bean type.

Parameters:

expectedType - The supertype of all types that can be referenced.

undefinedTypeMarker - A marker type to detect that the type parameter has its default value (undefined).

type - The bean type.

name - The bean name.

retrieval - How to retrieve the bean. See BeanRetrieval.

Returns:

The corresponding bean reference, or an empty optional if neither the type nor the name is provided.

toNullIfDefault

public <T> T toNullIfDefault(T value,
                             T defaultValue)

Specified by:

toNullIfDefault in interface MappingAnnotationProcessorContext

Parameters:

value - A value extracted from an annotation attribute.

defaultValue - A default value for that annotation attribute.

Returns:

null if value is equal to defaultValue, value otherwise.