Package org.exoplatform.commons.api.persistence

Class ExoEntityProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.exoplatform.commons.api.persistence.ExoEntityProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes("org.exoplatform.commons.api.persistence.ExoEntity")
@SupportedSourceVersion(RELEASE_21)
public class ExoEntityProcessor
extends AbstractProcessor

At compile time, every time a Maven module that uses @ExoEntity is compiled, the ExoEntityProcessor is invoked. This Annotation Processor (see JSR 269) creates an index that contains the list of all the JPA entities annotated with @ExoEntity of the module. This index is stored in the file “exo-jpa-entities/entities.idx” of the generated jar. Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com 7/22/15

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPRECATED_ENTITIES_IDX_PATH	Deprecated, for removal: This API element is subject to removal in a future version. will be removed to ease the path of entities listing
static final String	ENTITIES_IDX_PATH	Path to the generated entities.idx file

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ExoEntityProcessor()

Method Summary

Modifier and Type	Method	Description
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitialized

Methods inherited from class java.lang.Object

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

Field Details

DEPRECATED_ENTITIES_IDX_PATH

@Deprecated(forRemoval=true,
            since="1.6.0")
public static final String DEPRECATED_ENTITIES_IDX_PATH

Deprecated, for removal: This API element is subject to removal in a future version.

will be removed to ease the path of entities listing

See Also:

• Constant Field Values

ENTITIES_IDX_PATH

public static final String ENTITIES_IDX_PATH

Path to the generated entities.idx file

See Also:

• Constant Field Values

Constructor Details

ExoEntityProcessor

public ExoEntityProcessor()

Method Details

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor