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

public Class TypeConverterMetadata

extends AbstractConverterMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.converters.ObjectTypeConverterMetadata
Imports
org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.mappings.DatabaseMapping, org.eclipse.persistence.mappings.converters.TypeConversionConverter
INTERNAL: Object to hold onto a type converter metadata. 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 MetadataClass
m_dataType

private String
m_dataTypeName

private MetadataClass
m_objectType

private String
m_objectTypeName

Constructor Summary

AccessConstructor and Description
public
TypeConverterMetadata()

INTERNAL: Used for XML loading.

public
TypeConverterMetadata(MetadataAnnotation typeConverter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
TypeConverterMetadata(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.AbstractConverterMetadata.equals.

INTERNAL:
public MetadataClass
getDataType()

INTERNAL:

public MetadataClass
getDataType(MappingAccessor accessor, MetadataClass referenceClass)

INTERNAL:

public String
getDataTypeName()

INTERNAL: Used for OX mapping.

public MetadataClass
getObjectType(MappingAccessor accessor, MetadataClass referenceClass)

INTERNAL:

public MetadataClass
getObjectType()

INTERNAL:

public String
getObjectTypeName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.converters.AbstractConverterMetadata.hashCode.

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

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

Implements abstract org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter.process.

INTERNAL:
public void
setDataType(MetadataClass dataType)

INTERNAL:

public void
setDataTypeName(String dataTypeName)

INTERNAL: Used for OX mapping.

public void
setObjectType(MetadataClass objectType)

INTERNAL:

public void
setObjectTypeName(String objectTypeName)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.converters.AbstractConverterMetadata:
getIdentifiergetNameisStructConvertersetName

Field Detail

m_dataTypeback to summary
private MetadataClass m_dataType
m_dataTypeNameback to summary
private String m_dataTypeName
m_objectTypeback to summary
private MetadataClass m_objectType
m_objectTypeNameback to summary
private String m_objectTypeName

Constructor Detail

TypeConverterMetadataback to summary
public TypeConverterMetadata()

INTERNAL: Used for XML loading.

TypeConverterMetadataback to summary
public TypeConverterMetadata(MetadataAnnotation typeConverter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

TypeConverterMetadataback to summary
protected TypeConverterMetadata(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.AbstractConverterMetadata.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
getDataTypeback to summary
public MetadataClass getDataType()

INTERNAL:

getDataTypeback to summary
public MetadataClass getDataType(MappingAccessor accessor, MetadataClass referenceClass)

INTERNAL:

getDataTypeNameback to summary
public String getDataTypeName()

INTERNAL: Used for OX mapping.

getObjectTypeback to summary
public MetadataClass getObjectType(MappingAccessor accessor, MetadataClass referenceClass)

INTERNAL:

getObjectTypeback to summary
public MetadataClass getObjectType()

INTERNAL:

getObjectTypeNameback to summary
public String getObjectTypeName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.converters.AbstractConverterMetadata.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
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
processback to summary
public void process(DatabaseMapping mapping, MappingAccessor accessor, MetadataClass referenceClass, boolean isForMapKey)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.converters.MetadataConverter.process.

INTERNAL:

Annotations
@Override
setDataTypeback to summary
public void setDataType(MetadataClass dataType)

INTERNAL:

setDataTypeNameback to summary
public void setDataTypeName(String dataTypeName)

INTERNAL: Used for OX mapping.

setObjectTypeback to summary
public void setObjectType(MetadataClass objectType)

INTERNAL:

setObjectTypeNameback to summary
public void setObjectTypeName(String objectTypeName)

INTERNAL: Used for OX mapping.