Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metadata.converters

Class EnumeratedMetadata

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter

org.eclipse.persistence.internal.jpa.metadata.converters.EnumeratedMetadata

public class EnumeratedMetadata
extends MetadataConverter

INTERNAL: Abstract converter class that parents both the JPA and Eclipselink converters. 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:

EclipseLink 1.2

Author:

Guy Pelletier

Field Summary

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

m_project

Constructor Summary

Constructors

Constructor	Description
EnumeratedMetadata()	INTERNAL: Used for defaulting case.
EnumeratedMetadata(MetadataAccessor accessor)	INTERNAL: Used for defaulting.
EnumeratedMetadata(MetadataAnnotation enumerated, MetadataAccessor accessor)	INTERNAL: Used for annotation loading

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
String	getEnumeratedType()	INTERNAL: Used for OX mapping.
int	hashCode()
static boolean	isValidEnumeratedType(MetadataClass cls)	INTERNAL: Return true if the given class is a valid enum type.
void	process(DatabaseMapping mapping, MappingAccessor accessor, MetadataClass referenceClass, boolean isForMapKey)	INTERNAL: Every converter needs to be able to process themselves.
void	setEnumeratedType(String enumerated)	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter

setConverter, setConverterClassName, setFieldClassification, setFieldClassification

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumeratedMetadata

public EnumeratedMetadata()

INTERNAL: Used for defaulting case.

EnumeratedMetadata

public EnumeratedMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

EnumeratedMetadata

public EnumeratedMetadata(MetadataAnnotation enumerated,
                          MetadataAccessor accessor)

INTERNAL: Used for annotation loading

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class MetadataConverter

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getEnumeratedType

public String getEnumeratedType()

INTERNAL: Used for OX mapping.

isValidEnumeratedType

public static boolean isValidEnumeratedType(MetadataClass cls)

INTERNAL: Return true if the given class is a valid enum type.

process

public void process(DatabaseMapping mapping,
                    MappingAccessor accessor,
                    MetadataClass referenceClass,
                    boolean isForMapKey)

INTERNAL: Every converter needs to be able to process themselves.

Specified by:

process in class MetadataConverter

setEnumeratedType

public void setEnumeratedType(String enumerated)

INTERNAL: Used for OX mapping.