Class HibernateProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.hibernate.processor.HibernateProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

JPAMetaModelEntityProcessor

@SupportedAnnotationTypes({"jakarta.persistence.Entity","jakarta.persistence.MappedSuperclass","jakarta.persistence.Embeddable","jakarta.persistence.NamedQuery","jakarta.persistence.NamedQueries","jakarta.persistence.NamedNativeQuery","jakarta.persistence.NamedNativeQueries","jakarta.persistence.NamedEntityGraph","jakarta.persistence.NamedEntityGraphs","jakarta.persistence.SqlResultSetMapping","jakarta.persistence.SqlResultSetMappings","org.hibernate.annotations.FetchProfile","org.hibernate.annotations.FetchProfiles","org.hibernate.annotations.FilterDef","org.hibernate.annotations.FilterDefs","org.hibernate.annotations.NamedQuery","org.hibernate.annotations.NamedQueries","org.hibernate.annotations.NamedNativeQuery","org.hibernate.annotations.NamedNativeQueries","org.hibernate.annotations.processing.HQL","org.hibernate.annotations.processing.SQL","org.hibernate.annotations.processing.Find","jakarta.data.repository.Repository"})
@SupportedOptions({"debug","persistenceXml","ormXml","fullyAnnotationConfigured","lazyXmlParsing","addGenerationDate","addGeneratedAnnotation","addSuppressWarningsAnnotation","suppressJakartaDataMetamodel","include","exclude","index","jakartaDataSortCompliance"})
public class HibernateProcessor
extends AbstractProcessor

Main annotation processor.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_GENERATED_ANNOTATION	Whether the jakarta.annotation.Generated annotation should be added to the generated classes
static final String	ADD_GENERATION_DATE	Assuming that ADD_GENERATED_ANNOTATION is enabled, this option controls whether @Generated#date should be populated.
static final String	ADD_SUPPRESS_WARNINGS_ANNOTATION	A comma-separated list of warnings to suppress, or simply true if @SuppressWarnings({"deprecation","rawtypes"}) should be added to the generated classes.
static final String	DEBUG_OPTION	Debug logging from the processor
static final String	ENTITY_INDEX
static final String	EXCLUDE	Option to exclude certain types, according to a list of patterns.
static final String	FULLY_ANNOTATION_CONFIGURED_OPTION	Controls whether the processor should consider XML files
static final String	INCLUDE	Option to include only certain types, according to a list of patterns.
static final String	INDEX	Option to suppress creation of a filesystem-based index of entity types and enums for use by the query validator.
static final String	JAKARTA_DATA_SORT_COMPLIANCE	Option to suppress rejection of Jakarta Data repository interfaces that use jakarta.data.Sort types with a null type argument, which the Jakarta Data specification allows.
static final String	LAZY_XML_PARSING	Controls whether the processor should only load XML files when there have been changes
static final String	ORM_XML_OPTION	Path to an orm.xml file
static final String	PERSISTENCE_XML_OPTION	Path to a persistence.xml file
static final String	SUPPRESS_JAKARTA_DATA_METAMODEL	Option to suppress generation of the Jakarta Data static metamodel, even when Jakarta Data is available on the build path.

Fields inherited from class AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
HibernateProcessor()

Method Summary

Modifier and Type	Method	Description
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnvironment)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment)

Methods inherited from class AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class Object

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

Field Details

DEBUG_OPTION

public static final String DEBUG_OPTION

Debug logging from the processor

See Also:

• Constant Field Values

PERSISTENCE_XML_OPTION

public static final String PERSISTENCE_XML_OPTION

Path to a persistence.xml file

See Also:

• Constant Field Values

ORM_XML_OPTION

public static final String ORM_XML_OPTION

Path to an orm.xml file

See Also:

• Constant Field Values

FULLY_ANNOTATION_CONFIGURED_OPTION

public static final String FULLY_ANNOTATION_CONFIGURED_OPTION

Controls whether the processor should consider XML files

See Also:

• Constant Field Values

LAZY_XML_PARSING

public static final String LAZY_XML_PARSING

Controls whether the processor should only load XML files when there have been changes

See Also:

• Constant Field Values

ADD_GENERATED_ANNOTATION

public static final String ADD_GENERATED_ANNOTATION

Whether the jakarta.annotation.Generated annotation should be added to the generated classes

See Also:

• Constant Field Values

ADD_GENERATION_DATE

public static final String ADD_GENERATION_DATE

Assuming that ADD_GENERATED_ANNOTATION is enabled, this option controls whether @Generated#date should be populated.

See Also:

• Constant Field Values

ADD_SUPPRESS_WARNINGS_ANNOTATION

public static final String ADD_SUPPRESS_WARNINGS_ANNOTATION

A comma-separated list of warnings to suppress, or simply true if @SuppressWarnings({"deprecation","rawtypes"}) should be added to the generated classes.

See Also:

• Constant Field Values

SUPPRESS_JAKARTA_DATA_METAMODEL

public static final String SUPPRESS_JAKARTA_DATA_METAMODEL

Option to suppress generation of the Jakarta Data static metamodel, even when Jakarta Data is available on the build path.

See Also:

• Constant Field Values

JAKARTA_DATA_SORT_COMPLIANCE

public static final String JAKARTA_DATA_SORT_COMPLIANCE

Option to suppress rejection of Jakarta Data repository interfaces that use jakarta.data.Sort types with a null type argument, which the Jakarta Data specification allows.

See Also:

• Constant Field Values

INCLUDE

public static final String INCLUDE

Option to include only certain types, according to a list of patterns. The wildcard character is *, and patterns are comma-separated. For example: *.entity.*,*Repository. The default include is simply *, meaning that all types are included.

See Also:

• Constant Field Values

EXCLUDE

public static final String EXCLUDE

Option to exclude certain types, according to a list of patterns. The wildcard character is *, and patterns are comma-separated. For example: *.framework.*,*$$. The default exclude is empty.

See Also:

• Constant Field Values

INDEX

public static final String INDEX

Option to suppress creation of a filesystem-based index of entity types and enums for use by the query validator. By default, the index is created. The index is used to speed up query validation for faster compilation times.

See Also:

• Constant Field Values

ENTITY_INDEX

public static final String ENTITY_INDEX

See Also:

• Constant Field Values

Constructor Details

HibernateProcessor

public HibernateProcessor()

Method Details

init

public void init(ProcessingEnvironment processingEnvironment)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnvironment)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor