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

Class AnnotatedTypeSource

java.lang.Object

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

@Incubating
public abstract class AnnotatedTypeSource
extends Object

A source of types to be processed for annotations by Hibernate Search.

This is mainly useful when the following options are enabled:

• AnnotationMappingConfigurationContext.discoverAnnotatedTypesFromRootMappingAnnotations(boolean) discovering annotated types that are also annotated with root mapping annotations}.
• AnnotationMappingConfigurationContext.discoverJandexIndexesFromAddedTypes(boolean) discovering Jandex indexes from types added}

Method Summary

Modifier and Type	Method	Description
abstract void	apply(AnnotationMappingConfigurationContext context)
static AnnotatedTypeSource	empty()
static AnnotatedTypeSource	fromClasses(Class<?> clazz, Class<?>... otherClasses)
static AnnotatedTypeSource	fromClasses(Set<Class<?>> annotatedClasses)
static AnnotatedTypeSource	fromJandexIndex(org.jboss.jandex.IndexView jandexIndex)

Methods inherited from class java.lang.Object

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

Method Details

fromClasses

public static AnnotatedTypeSource fromClasses(Class<?> clazz,
 Class<?>... otherClasses)

Parameters:

clazz - A class annotated with Hibernate Search annotations, or (if taking advantage of Jandex-based discovery) a class within a JAR that contains other classes annotated with Hibernate Search annotations.

otherClasses - Other classes following the same requirements as firstClass.

Returns:

A source that adds the provided classes explicitly, and by default also allows other classes from the same JAR to be discovered automatically if they are annotated with root mapping annotations such as SearchEntity or ProjectionConstructor.

fromClasses

public static AnnotatedTypeSource fromClasses(Set<Class<?>> annotatedClasses)

Parameters:

annotatedClasses - Classes annotated with Hibernate Search annotations.

Returns:

A source that adds the provided classes explicitly. Note that other classes from the same JAR may be discovered automatically if they are annotated with root mapping annotations such as SearchEntity or ProjectionConstructor.

empty

public static AnnotatedTypeSource empty()

Returns:

An empty source. Only useful if you're planning on using programmatic mapping.

fromJandexIndex

public static AnnotatedTypeSource fromJandexIndex(org.jboss.jandex.IndexView jandexIndex)

Parameters:

jandexIndex - A Jandex index containing types annotated with Hibernate Search annotations.

Returns:

A source for discovering types annotated with root mapping annotations within the given index.

apply

public abstract void apply(AnnotationMappingConfigurationContext context)