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

Class AnnotationMappingConfigurationContextImpl

java.lang.Object

org.hibernate.search.mapper.pojo.mapping.definition.annotation.impl.AnnotationMappingConfigurationContextImpl

All Implemented Interfaces:

AnnotationMappingConfigurationContext, PojoMappingConfigurationContributor

public class AnnotationMappingConfigurationContextImpl
extends Object
implements AnnotationMappingConfigurationContext, PojoMappingConfigurationContributor

Constructor Summary

Constructors

Constructor	Description
AnnotationMappingConfigurationContextImpl(PojoBootstrapIntrospector introspector, MapperHints mapperHints)

Method Summary

Modifier and Type	Method	Description
AnnotationMappingConfigurationContext	add(Class<?> annotatedType)
AnnotationMappingConfigurationContext	add(Set<Class<?>> annotatedTypes)
AnnotationMappingConfigurationContext	addJandexIndex(org.jboss.jandex.IndexView jandexIndex)
AnnotationMappingConfigurationContext	buildMissingDiscoveredJandexIndexes(boolean enabled)
void	configure(MappingBuildContext buildContext, PojoMappingConfigurationContext configurationContext, MappingConfigurationCollector<PojoTypeMetadataContributor> collector)
AnnotationMappingConfigurationContext	discoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)
AnnotationMappingConfigurationContext	discoverAnnotationsFromReferencedTypes(boolean enabled)
AnnotationMappingConfigurationContext	discoverJandexIndexesFromAddedTypes(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationMappingConfigurationContextImpl

public AnnotationMappingConfigurationContextImpl(PojoBootstrapIntrospector introspector,
 MapperHints mapperHints)

Method Details

discoverAnnotatedTypesFromRootMappingAnnotations

public AnnotationMappingConfigurationContext discoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)

Specified by:

discoverAnnotatedTypesFromRootMappingAnnotations in interface AnnotationMappingConfigurationContext

Parameters:

enabled - true if Hibernate Search should automatically discover annotated types present in the Jandex index that are also annotated with root mapping annotations. When enabled, if an annotation meta-annotated with RootMapping is found in the Jandex index, and a type annotated with that annotation (e.g. SearchEntity or ProjectionConstructor) is found in the Jandex index, then that type will automatically be scanned for mapping annotations, even if the type wasn't added explicitly. false if that discovery should be disabled.

Returns:

this, for method chaining.

See Also:

• RootMapping
• SearchEntity
• ProjectionConstructor
• AnnotationMappingConfigurationContext.addJandexIndex(IndexView)
• AnnotationMappingConfigurationContext.discoverJandexIndexesFromAddedTypes(boolean)

discoverJandexIndexesFromAddedTypes

public AnnotationMappingConfigurationContext discoverJandexIndexesFromAddedTypes(boolean enabled)

Specified by:

discoverJandexIndexesFromAddedTypes in interface AnnotationMappingConfigurationContext

Parameters:

enabled - true if Hibernate Search should automatically discover Jandex Indexes from types added through AnnotationMappingConfigurationContext.add(Class) or AnnotationMappingConfigurationContext.add(Set). false if that discovery should be disabled.

Returns:

this, for method chaining.

See Also:

• AnnotationMappingConfigurationContext.addJandexIndex(IndexView)
• AnnotationMappingConfigurationContext.buildMissingDiscoveredJandexIndexes(boolean)

buildMissingDiscoveredJandexIndexes

public AnnotationMappingConfigurationContext buildMissingDiscoveredJandexIndexes(boolean enabled)

Specified by:

buildMissingDiscoveredJandexIndexes in interface AnnotationMappingConfigurationContext

Parameters:

enabled - true if Hibernate Search should automatically build Jandex Indexes when discovering Jandex indexes. false if Hibernate Search should ignore JARs without a Jandex index.

Returns:

this, for method chaining.

See Also:

• AnnotationMappingConfigurationContext.discoverJandexIndexesFromAddedTypes(boolean)
• AnnotationMappingConfigurationContext.addJandexIndex(IndexView)

discoverAnnotationsFromReferencedTypes

public AnnotationMappingConfigurationContext discoverAnnotationsFromReferencedTypes(boolean enabled)

Specified by:

discoverAnnotationsFromReferencedTypes in interface AnnotationMappingConfigurationContext

Parameters:

enabled - true if Hibernate Search should automatically process mapping annotations on types referenced in the mapping of other types (e.g. the target of an IndexedEmbedded, ...). false if that discovery should be disabled.

Returns:

this, for method chaining.

add

public AnnotationMappingConfigurationContext add(Class<?> annotatedType)

Specified by:

add in interface AnnotationMappingConfigurationContext

Parameters:

annotatedType - A type to scan for annotations.

Returns:

this, for method chaining.

add

public AnnotationMappingConfigurationContext add(Set<Class<?>> annotatedTypes)

Specified by:

add in interface AnnotationMappingConfigurationContext

Parameters:

annotatedTypes - A set of types to scan for annotations.

Returns:

this, for method chaining.

addJandexIndex

public AnnotationMappingConfigurationContext addJandexIndex(org.jboss.jandex.IndexView jandexIndex)

Specified by:

addJandexIndex in interface AnnotationMappingConfigurationContext

Parameters:

jandexIndex - A Jandex index to use when AnnotationMappingConfigurationContext.discoverAnnotatedTypesFromRootMappingAnnotations(boolean) discovering annotated types that are also annotated with root mapping annotations}.

Returns:

this, for method chaining.

See Also:

• AnnotationMappingConfigurationContext.discoverAnnotatedTypesFromRootMappingAnnotations(boolean)
• AnnotationMappingConfigurationContext.discoverJandexIndexesFromAddedTypes(boolean)

configure

public void configure(MappingBuildContext buildContext,
 PojoMappingConfigurationContext configurationContext,
 MappingConfigurationCollector<PojoTypeMetadataContributor> collector)

Specified by:

configure in interface PojoMappingConfigurationContributor