Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.converters

public abstract Class AbstractConverterMetadata

extends MetadataConverter
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.converters.ConverterMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.SerializedConverterMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.StructConverterMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.TypeConverterMetadata
Imports
org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Abstract metadata converter. 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.
Author
Guy Pelletier
Since
TopLink 11g

Field Summary

Modifier and TypeField and Description
private String
m_name

Constructor Summary

AccessConstructor and Description
protected
AbstractConverterMetadata(MetadataAnnotation converter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
AbstractConverterMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

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

INTERNAL:
public String
getIdentifier()

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

INTERNAL:
public String
getName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isStructConverter()

INTERNAL:

public void
setName(String name)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter:
processsetConvertersetConverterClassNamesetFieldClassificationsetFieldClassification

Field Detail

m_nameback to summary
private String m_name

Constructor Detail

AbstractConverterMetadataback to summary
protected AbstractConverterMetadata(MetadataAnnotation converter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

AbstractConverterMetadataback to summary
protected AbstractConverterMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

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

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getIdentifierback to summary
public String getIdentifier()

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

INTERNAL:

Annotations
@Override
getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isStructConverterback to summary
public boolean isStructConverter()

INTERNAL:

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.