org.eclipse.persistence.internal.jpa.metadata.listeners

Class EntityListener<T>

java.lang.Object

DescriptorEventAdapter

org.eclipse.persistence.internal.jpa.metadata.listeners.EntityListener<T>

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 java.lang.String	POST_BUILD
static java.lang.String	POST_CLONE
static java.lang.String	POST_DELETE
static java.lang.String	POST_INSERT
static java.lang.String	POST_REFRESH
static java.lang.String	POST_UPDATE
static java.lang.String	PRE_PERSIST
static java.lang.String	PRE_REMOVE
static java.lang.String	PRE_UPDATE_WITH_CHANGES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityListener(java.lang.Class entityClass) INTERNAL:
	EntityListener(java.lang.Class<T> listenerClass, java.lang.Class entityClass)

Method Summary

Modifier and Type	Method and Description
void	addEventMethod(java.lang.String event, java.lang.reflect.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(java.lang.Class<T> entityListenerClass) Create the wrapped listener and trigger CDI injection.
java.util.Map<java.lang.String,java.util.List<java.lang.reflect.Method>>	getAllEventMethods() INTERNAL:
java.lang.Class	getEntityClass() INTERNAL:
protected java.util.List<java.lang.reflect.Method>	getEventMethods(int eventCode) INTERNAL:
protected java.util.List<java.lang.reflect.Method>	getEventMethods(java.lang.String event) INTERNAL:
protected java.lang.reflect.Method	getLastEventMethod(java.lang.String event) INTERNAL: Assumes a check for event methods for the given event has been called beforehand.
T	getListener()
java.lang.Class	getListenerClass() INTERNAL:
AbstractSession	getOwningSession() INTERNAL:
boolean	hasCallbackMethods() INTERNAL:
protected boolean	hasEventMethods(int eventCode) INTERNAL:
protected boolean	hasEventMethods(java.lang.String event) INTERNAL:
protected boolean	hasOverriddenEventMethod(java.util.List<java.lang.reflect.Method> eventMethods, java.lang.reflect.Method eventMethod) INTERNAL:
protected boolean	hasOverriddenEventMethod(java.lang.reflect.Method eventMethod, int eventCode) INTERNAL:
protected boolean	hasOverriddenEventMethod(java.lang.reflect.Method eventMethod, java.lang.String eventCode) INTERNAL:
boolean	isOverriddenEvent(DescriptorEvent event, java.util.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(java.util.Map<java.lang.String,java.util.List<java.lang.reflect.Method>> methods) INTERNAL:
void	setOwningSession(AbstractSession owningSession) INTERNAL:
void	setPostBuildMethod(java.lang.reflect.Method method) INTERNAL:
void	setPostCloneMethod(java.lang.reflect.Method method) INTERNAL:
void	setPostDeleteMethod(java.lang.reflect.Method method) INTERNAL:
void	setPostInsertMethod(java.lang.reflect.Method method) INTERNAL:
void	setPostRefreshMethod(java.lang.reflect.Method method) INTERNAL:
void	setPostUpdateMethod(java.lang.reflect.Method method) INTERNAL:
void	setPrePersistMethod(java.lang.reflect.Method method) INTERNAL:
void	setPreRemoveMethod(java.lang.reflect.Method method) INTERNAL:
void	setPreUpdateWithChangesMethod(java.lang.reflect.Method method) INTERNAL:
java.lang.String	toString() INTERNAL: Used in the debugger.
protected void	validateMethod(java.lang.reflect.Method method) INTERNAL:
protected void	validateMethodModifiers(java.lang.reflect.Method method) INTERNAL:

Methods inherited from class java.lang.Object

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

Field Detail

POST_BUILD

public static final java.lang.String POST_BUILD

See Also:

Constant Field Values

POST_CLONE

public static final java.lang.String POST_CLONE

See Also:

Constant Field Values

POST_DELETE

public static final java.lang.String POST_DELETE

See Also:

Constant Field Values

POST_INSERT

public static final java.lang.String POST_INSERT

See Also:

Constant Field Values

POST_REFRESH

public static final java.lang.String POST_REFRESH

See Also:

Constant Field Values

POST_UPDATE

public static final java.lang.String POST_UPDATE

See Also:

Constant Field Values

PRE_PERSIST

public static final java.lang.String PRE_PERSIST

See Also:

Constant Field Values

PRE_REMOVE

public static final java.lang.String PRE_REMOVE

See Also:

Constant Field Values

PRE_UPDATE_WITH_CHANGES

public static final java.lang.String PRE_UPDATE_WITH_CHANGES

See Also:

Constant Field Values

Constructor Detail

EntityListener

protected EntityListener(java.lang.Class entityClass)

INTERNAL:

EntityListener

public EntityListener(java.lang.Class<T> listenerClass,
                      java.lang.Class entityClass)

Method Detail

addEventMethod

public void addEventMethod(java.lang.String event,
                           java.lang.reflect.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(java.lang.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 java.lang.Class getEntityClass()

INTERNAL:

getAllEventMethods

public java.util.Map<java.lang.String,java.util.List<java.lang.reflect.Method>> getAllEventMethods()

INTERNAL:

setAllEventMethods

public void setAllEventMethods(java.util.Map<java.lang.String,java.util.List<java.lang.reflect.Method>> methods)

INTERNAL:

setOwningSession

public void setOwningSession(AbstractSession owningSession)

INTERNAL:

getEventMethods

protected java.util.List<java.lang.reflect.Method> getEventMethods(int eventCode)

INTERNAL:

getEventMethods

protected java.util.List<java.lang.reflect.Method> getEventMethods(java.lang.String event)

INTERNAL:

getLastEventMethod

protected java.lang.reflect.Method getLastEventMethod(java.lang.String event)

INTERNAL: Assumes a check for event methods for the given event has been called beforehand.

getListener

public T getListener()

getListenerClass

public java.lang.Class getListenerClass()

INTERNAL:

getOwningSession

public AbstractSession getOwningSession()

INTERNAL:

hasCallbackMethods

public boolean hasCallbackMethods()

INTERNAL:

hasEventMethods

protected boolean hasEventMethods(int eventCode)

INTERNAL:

hasEventMethods

protected boolean hasEventMethods(java.lang.String event)

INTERNAL:

hasOverriddenEventMethod

protected boolean hasOverriddenEventMethod(java.util.List<java.lang.reflect.Method> eventMethods,
                                           java.lang.reflect.Method eventMethod)

INTERNAL:

hasOverriddenEventMethod

protected boolean hasOverriddenEventMethod(java.lang.reflect.Method eventMethod,
                                           int eventCode)

INTERNAL:

hasOverriddenEventMethod

protected boolean hasOverriddenEventMethod(java.lang.reflect.Method eventMethod,
                                           java.lang.String eventCode)

INTERNAL:

isOverriddenEvent

public boolean isOverriddenEvent(DescriptorEvent event,
                                 java.util.List<DescriptorEventManager> eventManagers)

INTERNAL: Return true if listener has a lifecycle callback method that is overridden in a subclass.

postBuild

public void postBuild(DescriptorEvent event)

INTERNAL:

postClone

public void postClone(DescriptorEvent event)

INTERNAL:

postDelete

public void postDelete(DescriptorEvent event)

INTERNAL:

postInsert

public void postInsert(DescriptorEvent event)

INTERNAL:

postRefresh

public void postRefresh(DescriptorEvent event)

INTERNAL:

postUpdate

public void postUpdate(DescriptorEvent event)

INTERNAL:

prePersist

public void prePersist(DescriptorEvent event)

INTERNAL:

preRemove

public void preRemove(DescriptorEvent event)

INTERNAL:

preUpdateWithChanges

public void preUpdateWithChanges(DescriptorEvent event)

INTERNAL:

setPostBuildMethod

public void setPostBuildMethod(java.lang.reflect.Method method)

INTERNAL:

setPostCloneMethod

public void setPostCloneMethod(java.lang.reflect.Method method)

INTERNAL:

setPostDeleteMethod

public void setPostDeleteMethod(java.lang.reflect.Method method)

INTERNAL:

setPostInsertMethod

public void setPostInsertMethod(java.lang.reflect.Method method)

INTERNAL:

setPostRefreshMethod

public void setPostRefreshMethod(java.lang.reflect.Method method)

INTERNAL:

setPostUpdateMethod

public void setPostUpdateMethod(java.lang.reflect.Method method)

INTERNAL:

setPrePersistMethod

public void setPrePersistMethod(java.lang.reflect.Method method)

INTERNAL:

setPreRemoveMethod

public void setPreRemoveMethod(java.lang.reflect.Method method)

INTERNAL:

setPreUpdateWithChangesMethod

public void setPreUpdateWithChangesMethod(java.lang.reflect.Method method)

INTERNAL:

toString

public java.lang.String toString()

INTERNAL: Used in the debugger.

validateMethod

protected void validateMethod(java.lang.reflect.Method method)

INTERNAL:

validateMethodModifiers

protected void validateMethodModifiers(java.lang.reflect.Method method)

INTERNAL: