Interface EntityProcessorContext
-
- All Known Implementing Classes:
EntityProcessorContextImpl
public interface EntityProcessorContextEntity processorcontext providing details about entity processing. The context contains theEntityProcessorContext.Typewhich distinguishes between types of context. There are various properties in the context (accessible by getters) and some of them might be relevant only to specific context types.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classEntityProcessorContext.TypeThe type of the context which describes in which entity processing phase theEntityProcessor.process(EntityProcessorContext)is triggered.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Class<?>getEntityClass()Get entity class to be processed.EntityGraphgetEntityGraph()Get entity graph to be modified by the processing.java.lang.reflect.FieldgetField()Get field to be processed.java.lang.reflect.MethodgetMethod()Get method to be processed.EntityProcessorContext.TypegetType()Get thetypeof this context.
-
-
-
Method Detail
-
getType
EntityProcessorContext.Type getType()
Get thetypeof this context.- Returns:
- entity processing context type.
-
getEntityClass
java.lang.Class<?> getEntityClass()
Get entity class to be processed. The entity class is available only forEntityProcessorContext.Type.CLASS_WRITERandEntityProcessorContext.Type.CLASS_READERcontext types.- Returns:
- entity class or
nullif the class is not available.
-
getField
java.lang.reflect.Field getField()
Get field to be processed. The field is available only forEntityProcessorContext.Type.PROPERTY_WRITERandEntityProcessorContext.Type.PROPERTY_READERcontext types.- Returns:
- field or
nullif the field is not available.
-
getMethod
java.lang.reflect.Method getMethod()
Get method to be processed. The method is available forEntityProcessorContext.Type.PROPERTY_WRITER,EntityProcessorContext.Type.PROPERTY_READER,EntityProcessorContext.Type.METHOD_WRITER,EntityProcessorContext.Type.METHOD_READERcontext types.- Returns:
- method or
nullif the method is not available.
-
getEntityGraph
EntityGraph getEntityGraph()
Get entity graph to be modified by the processing. The entity graph is available for all context types.- Returns:
- entity graph.
-
-