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

public Class StructConverterMetadata

extends AbstractConverterMetadata
Class Inheritance
Imports
java.sql.Types, org.eclipse.persistence.config.StructConverterType, org.eclipse.persistence.exceptions.ValidationException, 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.MetadataAnnotation, .MetadataClass, org.eclipse.persistence.mappings.DatabaseMapping, org.eclipse.persistence.mappings.foundation.AbstractDirectMapping
INTERNAL: Place holder for a StructConverter This class will allow a StructConverter to be added to a Session through annotations when defined with the StructConverter annotation. 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.

Field Summary

Modifier and TypeField and Description
private String
m_converter

Constructor Summary

AccessConstructor and Description
public
StructConverterMetadata()

INTERNAL: Used for XML loading.

public
StructConverterMetadata(MetadataAnnotation structConverter, MetadataAccessor accessor)

INTERNAL: Used for annotation 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 String
getConverter()

INTERNAL: Used for OX mapping.

public String
getConverterClassName()

INTERNAL:

public int
hashCode()

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

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

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

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
setConverter(String converter)

INTERNAL: Used for OX mapping.

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

Field Detail

m_converterback to summary
private String m_converter

Constructor Detail

StructConverterMetadataback to summary
public StructConverterMetadata()

INTERNAL: Used for XML loading.

StructConverterMetadataback to summary
public StructConverterMetadata(MetadataAnnotation structConverter, MetadataAccessor accessor)

INTERNAL: Used for annotation 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
getConverterback to summary
public String getConverter()

INTERNAL: Used for OX mapping.

getConverterClassNameback to summary
public String getConverterClassName()

INTERNAL:

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
isStructConverterback to summary
public boolean isStructConverter()

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

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
setConverterback to summary
public void setConverter(String converter)

INTERNAL: Used for OX mapping.