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

Interface AnnotationMappingConfigurationContext

All Known Implementing Classes:

AnnotationMappingConfigurationContextImpl

public interface AnnotationMappingConfigurationContext

A context to configure annotation mapping.

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)
AnnotationMappingConfigurationContext	discoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)
AnnotationMappingConfigurationContext	discoverAnnotationsFromReferencedTypes(boolean enabled)
AnnotationMappingConfigurationContext	discoverJandexIndexesFromAddedTypes(boolean enabled)

Method Details

discoverAnnotatedTypesFromRootMappingAnnotations

AnnotationMappingConfigurationContext discoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)

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
• addJandexIndex(IndexView)
• discoverJandexIndexesFromAddedTypes(boolean)

discoverJandexIndexesFromAddedTypes

AnnotationMappingConfigurationContext discoverJandexIndexesFromAddedTypes(boolean enabled)

Parameters:

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

Returns:

this, for method chaining.

See Also:

• addJandexIndex(IndexView)
• buildMissingDiscoveredJandexIndexes(boolean)

buildMissingDiscoveredJandexIndexes

AnnotationMappingConfigurationContext buildMissingDiscoveredJandexIndexes(boolean enabled)

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:

• discoverJandexIndexesFromAddedTypes(boolean)
• addJandexIndex(IndexView)

discoverAnnotationsFromReferencedTypes

AnnotationMappingConfigurationContext discoverAnnotationsFromReferencedTypes(boolean enabled)

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

AnnotationMappingConfigurationContext add(Class<?> annotatedType)

Parameters:

annotatedType - A type to scan for annotations.

Returns:

this, for method chaining.

add

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

Parameters:

annotatedTypes - A set of types to scan for annotations.

Returns:

this, for method chaining.

addJandexIndex

@Incubating
AnnotationMappingConfigurationContext addJandexIndex(org.jboss.jandex.IndexView jandexIndex)

Parameters:

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

Returns:

this, for method chaining.

See Also:

• discoverAnnotatedTypesFromRootMappingAnnotations(boolean)
• discoverJandexIndexesFromAddedTypes(boolean)