Interface AnnotationMappingConfigurationContext
-
- All Known Implementing Classes:
AnnotationMappingConfigurationContextImpl
public interface AnnotationMappingConfigurationContextA context to configure annotation mapping.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AnnotationMappingConfigurationContextadd(Class<?> annotatedType)AnnotationMappingConfigurationContextadd(Set<Class<?>> annotatedTypes)AnnotationMappingConfigurationContextaddJandexIndex(org.jboss.jandex.IndexView jandexIndex)AnnotationMappingConfigurationContextbuildMissingDiscoveredJandexIndexes(boolean enabled)AnnotationMappingConfigurationContextdiscoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)AnnotationMappingConfigurationContextdiscoverAnnotationsFromReferencedTypes(boolean enabled)AnnotationMappingConfigurationContextdiscoverJandexIndexesFromAddedTypes(boolean enabled)
-
-
-
Method Detail
-
discoverAnnotatedTypesFromRootMappingAnnotations
AnnotationMappingConfigurationContext discoverAnnotatedTypesFromRootMappingAnnotations(boolean enabled)
- Parameters:
enabled-trueif Hibernate Search should automatically discover annotated types present in the Jandex index that are also annotated withroot mapping annotations. When enabled, if an annotation meta-annotated withRootMappingis found in the Jandex index, and a type annotated with that annotation (e.g.ProjectionConstructor) is found in the Jandex index, then that type will automatically be scanned for mapping annotations, even if the type wasn'tadded explicitly.falseif that discovery should be disabled.- Returns:
this, for method chaining.- See Also:
RootMapping,ProjectionConstructor,addJandexIndex(IndexView),discoverJandexIndexesFromAddedTypes(boolean)
-
discoverJandexIndexesFromAddedTypes
AnnotationMappingConfigurationContext discoverJandexIndexesFromAddedTypes(boolean enabled)
- Parameters:
enabled-trueif Hibernate Search should automatically discover Jandex Indexes from types added throughadd(Class)oradd(Set).falseif that discovery should be disabled.- Returns:
this, for method chaining.- See Also:
addJandexIndex(IndexView),buildMissingDiscoveredJandexIndexes(boolean)
-
buildMissingDiscoveredJandexIndexes
AnnotationMappingConfigurationContext buildMissingDiscoveredJandexIndexes(boolean enabled)
- Parameters:
enabled-trueif Hibernate Search should automatically build Jandex Indexes whendiscovering Jandex indexes.falseif 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-trueif Hibernate Search should automatically process mapping annotations on types referenced in the mapping of other types (e.g. the target of anIndexedEmbedded, ...).falseif 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 whendiscoverAnnotatedTypesFromRootMappingAnnotations(boolean)discovering annotated types that are also annotated with root mapping annotations}.- Returns:
this, for method chaining.- See Also:
discoverAnnotatedTypesFromRootMappingAnnotations(boolean),discoverJandexIndexesFromAddedTypes(boolean)
-
-