EntityListenerMetadata (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.ORMetadata
- - org.eclipse.persistence.internal.jpa.metadata.listeners.EntityListenerMetadata

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

EntityClassListenerMetadata
```
public class EntityListenerMetadata
extends ORMetadata
implements java.lang.Cloneable
```
A MetadataEntityListener and 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. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

TopLink 10.1.3/EJB 3.0 Preview

Author:

Guy Pelletier

Constructor Summary

Constructors
Constructor and Description
`EntityListenerMetadata()` INTERNAL: Used for XML loading.
`EntityListenerMetadata(MetadataAnnotation entityListeners, MetadataClass entityListenerClass, MetadataAccessor accessor)` INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` INTERNAL: This method should be called when dealing with default listeners.
`boolean`	`equals(java.lang.Object objectToCompare)` INTERNAL:
`java.lang.String`	`getClassName()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getIdentifier()` INTERNAL:
`java.lang.String`	`getPostLoad()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getPostPersist()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getPostRemove()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getPostUpdate()` INTERNAL: Used for OX mapping
`java.lang.String`	`getPrePersist()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getPreRemove()` INTERNAL: Used for OX mapping.
`java.lang.String`	`getPreUpdate()` INTERNAL: Used for OX mapping.
`void`	`initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)` INTERNAL:
`void`	`process(ClassAccessor classAccessor, java.lang.ClassLoader loader, boolean isDefaultListener)` INTERNAL:
`void`	`setClassName(java.lang.String className)` INTERNAL: Used for OX mapping.
`void`	`setPostLoad(java.lang.String postLoad)` INTERNAL: Used for OX mapping.
`void`	`setPostPersist(java.lang.String postPersist)` INTERNAL: Used for OX mapping.
`void`	`setPostRemove(java.lang.String postRemove)` INTERNAL: Used for OX mapping.
`void`	`setPostUpdate(java.lang.String postUpdate)` INTERNAL: Used for OX mapping.
`void`	`setPrePersist(java.lang.String prePersist)` INTERNAL: Used for OX mapping
`void`	`setPreRemove(java.lang.String preRemove)` INTERNAL: Used for OX mapping.
`void`	`setPreUpdate(java.lang.String preUpdate)` INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityListenerMetadata
```
public EntityListenerMetadata()
```
INTERNAL: Used for XML loading.

EntityListenerMetadata

public EntityListenerMetadata(MetadataAnnotation entityListeners,
                              MetadataClass entityListenerClass,
                              MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

clone
```
public java.lang.Object clone()
```
INTERNAL: This method should be called when dealing with default listeners.

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Specified by:: equals in class ORMetadata

getClassName
```
public java.lang.String getClassName()
```
INTERNAL: Used for OX mapping.

getIdentifier
```
public java.lang.String getIdentifier()
```
INTERNAL:

See Also:

shouldOverride, mergeListsAndOverride

getPostLoad
```
public java.lang.String getPostLoad()
```
INTERNAL: Used for OX mapping.

getPostPersist
```
public java.lang.String getPostPersist()
```
INTERNAL: Used for OX mapping.

getPostRemove
```
public java.lang.String getPostRemove()
```
INTERNAL: Used for OX mapping.

getPostUpdate
```
public java.lang.String getPostUpdate()
```
INTERNAL: Used for OX mapping

getPrePersist
```
public java.lang.String getPrePersist()
```
INTERNAL: Used for OX mapping.

getPreRemove
```
public java.lang.String getPreRemove()
```
INTERNAL: Used for OX mapping.

getPreUpdate
```
public java.lang.String getPreUpdate()
```
INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:: initXMLObject in class ORMetadata

process

public void process(ClassAccessor classAccessor,
                    java.lang.ClassLoader loader,
                    boolean isDefaultListener)

INTERNAL: