EntityListener (EclipseLink JPA 3.0.1 API)

java.lang.Object
- org.eclipse.persistence.descriptors.DescriptorEventAdapter
- - org.eclipse.persistence.internal.jpa.metadata.listeners.EntityListener<T>

All Implemented Interfaces:

EventListener, DescriptorEventListener

Direct Known Subclasses:

EntityClassListener
```
public class EntityListener<T>
extends DescriptorEventAdapter
```
An EntityListener is placed on the owning entity's descriptor. Callback methods from an EntityListener require a signature on the method. Namely, they must have an Object parameter.

Since:

Eclipselink 1.0

Author:

Guy Pelletier

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`POST_BUILD`
`static String`	`POST_CLONE`
`static String`	`POST_DELETE`
`static String`	`POST_INSERT`
`static String`	`POST_REFRESH`
`static String`	`POST_UPDATE`
`static String`	`PRE_PERSIST`
`static String`	`PRE_REMOVE`
`static String`	`PRE_UPDATE_WITH_CHANGES`

Constructor Summary

Constructors
Modifier Constructor and Description

protected EntityListener(Class entityClass)
INTERNAL:

EntityListener(Class<T> listenerClass, Class entityClass)

Constructors
Modifier	Constructor and Description
`protected`	`EntityListener(Class entityClass)` INTERNAL:
	`EntityListener(Class<T> listenerClass, Class entityClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventMethod(String event, Method method)` INTERNAL: You can have multiple event methods for the same event, however, only one event method per class is permitted.
`protected T`	`constructListenerInstance()` Construct an instance of the wrapped entity listener This method will attempt to create the listener in a CDI injection friendly manner and if that fails, reflectively instantiate the class
`protected T`	`createEntityListenerAndInjectDependencies(Class<T> entityListenerClass)` Create the wrapped listener and trigger CDI injection.
`Map<String,List<Method>>`	`getAllEventMethods()` INTERNAL:
`Class`	`getEntityClass()` INTERNAL:
`protected List<Method>`	`getEventMethods(int eventCode)` INTERNAL:
`protected List<Method>`	`getEventMethods(String event)` INTERNAL:
`protected Method`	`getLastEventMethod(String event)` INTERNAL: Assumes a check for event methods for the given event has been called beforehand.
`T`	`getListener()`
`Class`	`getListenerClass()` INTERNAL:
`AbstractSession`	`getOwningSession()` INTERNAL:
`boolean`	`hasCallbackMethods()` INTERNAL:
`protected boolean`	`hasEventMethods(int eventCode)` INTERNAL:
`protected boolean`	`hasEventMethods(String event)` INTERNAL:
`protected boolean`	`hasOverriddenEventMethod(List<Method> eventMethods, Method eventMethod)` INTERNAL:
`protected boolean`	`hasOverriddenEventMethod(Method eventMethod, int eventCode)` INTERNAL:
`protected boolean`	`hasOverriddenEventMethod(Method eventMethod, String eventCode)` INTERNAL:
`boolean`	`isOverriddenEvent(DescriptorEvent event, List<DescriptorEventManager> eventManagers)` INTERNAL: Return true if listener has a lifecycle callback method that is overridden in a subclass.
`void`	`postBuild(DescriptorEvent event)` INTERNAL:
`void`	`postClone(DescriptorEvent event)` INTERNAL:
`void`	`postDelete(DescriptorEvent event)` INTERNAL:
`void`	`postInsert(DescriptorEvent event)` INTERNAL:
`void`	`postRefresh(DescriptorEvent event)` INTERNAL:
`void`	`postUpdate(DescriptorEvent event)` INTERNAL:
`void`	`prePersist(DescriptorEvent event)` INTERNAL:
`void`	`preRemove(DescriptorEvent event)` INTERNAL:
`void`	`preUpdateWithChanges(DescriptorEvent event)` INTERNAL:
`void`	`setAllEventMethods(Map<String,List<Method>> methods)` INTERNAL:
`void`	`setOwningSession(AbstractSession owningSession)` INTERNAL:
`void`	`setPostBuildMethod(Method method)` INTERNAL:
`void`	`setPostCloneMethod(Method method)` INTERNAL:
`void`	`setPostDeleteMethod(Method method)` INTERNAL:
`void`	`setPostInsertMethod(Method method)` INTERNAL:
`void`	`setPostRefreshMethod(Method method)` INTERNAL:
`void`	`setPostUpdateMethod(Method method)` INTERNAL:
`void`	`setPrePersistMethod(Method method)` INTERNAL:
`void`	`setPreRemoveMethod(Method method)` INTERNAL:
`void`	`setPreUpdateWithChangesMethod(Method method)` INTERNAL:
`String`	`toString()` INTERNAL: Used in the debugger.
`protected void`	`validateMethod(Method method)` INTERNAL:
`protected void`	`validateMethodModifiers(Method method)` INTERNAL:

Methods inherited from class org.eclipse.persistence.descriptors.DescriptorEventAdapter
aboutToDelete, aboutToInsert, aboutToUpdate, postMerge, postWrite, preDelete, preInsert, preUpdate, preWrite

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - POST_BUILD
```
public static final String POST_BUILD
```
    See Also:
    
    Constant Field Values
  - POST_CLONE
```
public static final String POST_CLONE
```
    See Also:
    
    Constant Field Values
  - POST_DELETE
```
public static final String POST_DELETE
```
    See Also:
    
    Constant Field Values
  - POST_INSERT
```
public static final String POST_INSERT
```
    See Also:
    
    Constant Field Values
  - POST_REFRESH
```
public static final String POST_REFRESH
```
    See Also:
    
    Constant Field Values
  - POST_UPDATE
```
public static final String POST_UPDATE
```
    See Also:
    
    Constant Field Values
  - PRE_PERSIST
```
public static final String PRE_PERSIST
```
    See Also:
    
    Constant Field Values
  - PRE_REMOVE
```
public static final String PRE_REMOVE
```
    See Also:
    
    Constant Field Values
  - PRE_UPDATE_WITH_CHANGES
```
public static final String PRE_UPDATE_WITH_CHANGES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EntityListener
```
protected EntityListener(Class entityClass)
```
    INTERNAL:
  - EntityListener
```
public EntityListener(Class<T> listenerClass,
                      Class entityClass)
```
- Method Detail
  - addEventMethod
```
public void addEventMethod(String event,
                           Method method)
```
    INTERNAL: You can have multiple event methods for the same event, however, only one event method per class is permitted.
  - createEntityListenerAndInjectDependencies
```
protected T createEntityListenerAndInjectDependencies(Class<T> entityListenerClass)
```
    Create the wrapped listener and trigger CDI injection.
    
    Parameters:
    
    entityListenerClass - the EntityListener class
    
    Returns:
    
    the class instance that has had injection run on it. If injection fails, null.
  - constructListenerInstance
```
protected T constructListenerInstance()
```
    Construct an instance of the wrapped entity listener This method will attempt to create the listener in a CDI injection friendly manner and if that fails, reflectively instantiate the class
    
    Returns:
    
    the entity listener instance
  - getEntityClass
```
public Class getEntityClass()
```
    INTERNAL:
  - getAllEventMethods
```
public Map<String,List<Method>> getAllEventMethods()
```
    INTERNAL:
  - setAllEventMethods
```
public void setAllEventMethods(Map<String,List<Method>> methods)
```
    INTERNAL:
  - setOwningSession
```
public void setOwningSession(AbstractSession owningSession)
```
    INTERNAL:
  - getEventMethods
```
protected List<Method> getEventMethods(int eventCode)
```
    INTERNAL:
  - getEventMethods
```
protected List<Method> getEventMethods(String event)
```
    INTERNAL:
  - getLastEventMethod
```
protected Method getLastEventMethod(String event)
```
    INTERNAL: Assumes a check for event methods for the given event has been called beforehand.
  - getListener
```
public T getListener()
```
  - getListenerClass
```
public Class getListenerClass()
```
    INTERNAL:
  - getOwningSession
```
public AbstractSession getOwningSession()
```
    INTERNAL:
  - hasCallbackMethods
```
public boolean hasCallbackMethods()
```
    INTERNAL:
  - hasEventMethods
```
protected boolean hasEventMethods(int eventCode)
```
    INTERNAL:
  - hasEventMethods
```
protected boolean hasEventMethods(String event)
```
    INTERNAL:
  - hasOverriddenEventMethod
```
protected boolean hasOverriddenEventMethod(List<Method> eventMethods,
                                           Method eventMethod)
```
    INTERNAL:
  - hasOverriddenEventMethod
```
protected boolean hasOverriddenEventMethod(Method eventMethod,
                                           int eventCode)
```
    INTERNAL:
  - hasOverriddenEventMethod
```
protected boolean hasOverriddenEventMethod(Method eventMethod,
                                           String eventCode)
```
    INTERNAL:
  - isOverriddenEvent
```
public boolean isOverriddenEvent(DescriptorEvent event,
                                 List<DescriptorEventManager> eventManagers)
```
    INTERNAL: Return true if listener has a lifecycle callback method that is overridden in a subclass.
    
    Specified by:
    
    isOverriddenEvent in interface DescriptorEventListener
    
    Overrides:
    
    isOverriddenEvent in class DescriptorEventAdapter
  - postBuild
```
public void postBuild(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postBuild in interface DescriptorEventListener
    
    Overrides:
    
    postBuild in class DescriptorEventAdapter
  - postClone
```
public void postClone(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postClone in interface DescriptorEventListener
    
    Overrides:
    
    postClone in class DescriptorEventAdapter
  - postDelete
```
public void postDelete(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postDelete in interface DescriptorEventListener
    
    Overrides:
    
    postDelete in class DescriptorEventAdapter
  - postInsert
```
public void postInsert(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postInsert in interface DescriptorEventListener
    
    Overrides:
    
    postInsert in class DescriptorEventAdapter
  - postRefresh
```
public void postRefresh(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postRefresh in interface DescriptorEventListener
    
    Overrides:
    
    postRefresh in class DescriptorEventAdapter
  - postUpdate
```
public void postUpdate(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    postUpdate in interface DescriptorEventListener
    
    Overrides:
    
    postUpdate in class DescriptorEventAdapter
  - prePersist
```
public void prePersist(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    prePersist in interface DescriptorEventListener
    
    Overrides:
    
    prePersist in class DescriptorEventAdapter
  - preRemove
```
public void preRemove(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    preRemove in interface DescriptorEventListener
    
    Overrides:
    
    preRemove in class DescriptorEventAdapter
  - preUpdateWithChanges
```
public void preUpdateWithChanges(DescriptorEvent event)
```
    INTERNAL:
    
    Specified by:
    
    preUpdateWithChanges in interface DescriptorEventListener
    
    Overrides:
    
    preUpdateWithChanges in class DescriptorEventAdapter
  - setPostBuildMethod
```
public void setPostBuildMethod(Method method)
```
    INTERNAL:
  - setPostCloneMethod
```
public void setPostCloneMethod(Method method)
```
    INTERNAL:
  - setPostDeleteMethod
```
public void setPostDeleteMethod(Method method)
```
    INTERNAL:
  - setPostInsertMethod
```
public void setPostInsertMethod(Method method)
```
    INTERNAL:
  - setPostRefreshMethod
```
public void setPostRefreshMethod(Method method)
```
    INTERNAL:
  - setPostUpdateMethod
```
public void setPostUpdateMethod(Method method)
```
    INTERNAL:
  - setPrePersistMethod
```
public void setPrePersistMethod(Method method)
```
    INTERNAL:
  - setPreRemoveMethod
```
public void setPreRemoveMethod(Method method)
```
    INTERNAL:
  - setPreUpdateWithChangesMethod
```
public void setPreUpdateWithChangesMethod(Method method)
```
    INTERNAL:
  - toString
```
public String toString()
```
    INTERNAL: Used in the debugger.
    
    Overrides:
    
    toString in class Object
  - validateMethod
```
protected void validateMethod(Method method)
```
    INTERNAL:
  - validateMethodModifiers
```
protected void validateMethodModifiers(Method method)
```
    INTERNAL:

Class EntityListener<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.descriptors.DescriptorEventAdapter

Methods inherited from class java.lang.Object

Field Detail

POST_BUILD

POST_CLONE

POST_DELETE

POST_INSERT

POST_REFRESH

POST_UPDATE

PRE_PERSIST

PRE_REMOVE

PRE_UPDATE_WITH_CHANGES

Constructor Detail

EntityListener

EntityListener

Method Detail

addEventMethod

createEntityListenerAndInjectDependencies

constructListenerInstance

getEntityClass

getAllEventMethods

setAllEventMethods

setOwningSession

getEventMethods

getEventMethods

getLastEventMethod

getListener

getListenerClass

getOwningSession

hasCallbackMethods

hasEventMethods

hasEventMethods

hasOverriddenEventMethod

hasOverriddenEventMethod

hasOverriddenEventMethod

isOverriddenEvent

postBuild

postClone

postDelete

postInsert

postRefresh

postUpdate

prePersist

preRemove

preUpdateWithChanges

setPostBuildMethod

setPostCloneMethod

setPostDeleteMethod

setPostInsertMethod

setPostRefreshMethod

setPostUpdateMethod

setPrePersistMethod

setPreRemoveMethod

setPreUpdateWithChangesMethod

toString

validateMethod

validateMethodModifiers