org.eclipse.jpt.jpa.eclipselink.core.resource.java
Interface EclipseLinkBaseTypeConverterAnnotation

All Superinterfaces:

Annotation, EclipseLinkNamedConverterAnnotation, JavaResourceNode, Model, NestableAnnotation

All Known Subinterfaces:

EclipseLinkObjectTypeConverterAnnotation, EclipseLinkTypeConverterAnnotation

public interface EclipseLinkBaseTypeConverterAnnotation
extends EclipseLinkNamedConverterAnnotation

Common protocol among:

• org.eclipse.persistence.annotations.TypeConverter
• org.eclipse.persistence.annotations.ObjectTypeConverter

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

JavaResourceNode.FileTransformer, JavaResourceNode.Root

Field Summary

static String	DATA_TYPE_PROPERTY
static String	OBJECT_TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.eclipselink.core.resource.java.EclipseLinkNamedConverterAnnotation

NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

FILE_TRANSFORMER

Method Summary

String	getDataType() Corresponds to the 'dataType' element of the TypeConverter annotation.
TextRange	getDataTypeTextRange() Return the TextRange for the 'dataType' element.
String	getFullyQualifiedDataType() Return the fully-qualified data type name as resolved by the AST's bindings.
String	getFullyQualifiedObjectType() Return the fully-qualified object type name as resolved by the AST's bindings.
String	getObjectType() Corresponds to the 'objectType' element of the TypeConverter annotation.
TextRange	getObjectTypeTextRange() Return the TextRange for the 'objectType' element.
void	setDataType(String dataType) Corresponds to the 'dataType' element of the TypeConverter annotation.
void	setObjectType(String objectType) Corresponds to the 'objectType' element of the TypeConverter annotation.

Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.resource.java.EclipseLinkNamedConverterAnnotation

getName, getNameTextRange, setName

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.NestableAnnotation

moveAnnotation

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, initialize, initialize, isUnset, newAnnotation, removeAnnotation, synchronizeWith, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Field Detail

DATA_TYPE_PROPERTY

static final String DATA_TYPE_PROPERTY

See Also:

Constant Field Values

OBJECT_TYPE_PROPERTY

static final String OBJECT_TYPE_PROPERTY

See Also:

Constant Field Values

Method Detail

getDataType

String getDataType()

Corresponds to the 'dataType' element of the TypeConverter annotation. Returns null if the element does not exist in Java.

setDataType

void setDataType(String dataType)

Corresponds to the 'dataType' element of the TypeConverter annotation. Set to null to remove the element.

getDataTypeTextRange

TextRange getDataTypeTextRange()

Return the TextRange for the 'dataType' element. If the element does not exist return the TextRange for the TypeConverter annotation.

getFullyQualifiedDataType

String getFullyQualifiedDataType()

Return the fully-qualified data type name as resolved by the AST's bindings.

     @TypeConverter(dataType = MyDataType.class)
 

will return "model.MyDataType" if there is an import for model.MyDataType.

getObjectType

String getObjectType()

Corresponds to the 'objectType' element of the TypeConverter annotation. Returns null if the element does not exist in Java.

setObjectType

void setObjectType(String objectType)

Corresponds to the 'objectType' element of the TypeConverter annotation. Set to null to remove the element.

getObjectTypeTextRange

TextRange getObjectTypeTextRange()

Return the TextRange for the 'objectType' element. If the element does not exist return the TextRange for the TypeConverter annotation.

getFullyQualifiedObjectType

String getFullyQualifiedObjectType()

Return the fully-qualified object type name as resolved by the AST's bindings.

     @TypeConverter(dataType = MyObjectType.class)
 

will return "model.MyObjectType" if there is an import for model.MyObjectType.