org.eclipse.jpt.eclipselink.core.resource.java
Interface EclipseLinkObjectTypeConverterAnnotation

All Superinterfaces:

Annotation, BaseEclipseLinkTypeConverterAnnotation, EclipseLinkNamedConverterAnnotation, JavaResourceNode, Model

public interface EclipseLinkObjectTypeConverterAnnotation
extends BaseEclipseLinkTypeConverterAnnotation

Corresponds to the EclipseLink annotation 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.

Since:

2.1

Version:

2.1

Nested Class Summary

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

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	CONVERSION_VALUES_LIST
static java.lang.String	DEFAULT_OBJECT_VALUE_PROPERTY

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

DATA_TYPE_PROPERTY, FULLY_QUALIFIED_DATA_TYPE_PROPERTY, FULLY_QUALIFIED_OBJECT_TYPE_PROPERTY, OBJECT_TYPE_PROPERTY

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

NAME_PROPERTY

Method Summary

EclipseLinkConversionValueAnnotation	addConversionValue(int index) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
EclipseLinkConversionValueAnnotation	conversionValueAt(int index) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
java.util.ListIterator<EclipseLinkConversionValueAnnotation>	conversionValues() Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
int	conversionValuesSize() Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
java.lang.String	getDefaultObjectValue() Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation.
TextRange	getDefaultObjectValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'defaultObjectValue' element.
int	indexOfConversionValue(EclipseLinkConversionValueAnnotation conversionValue) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
void	moveConversionValue(int targetIndex, int sourceIndex) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
void	removeConversionValue(int index) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
void	setDefaultObjectValue(java.lang.String value) Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation.

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

getDataType, getDataTypeTextRange, getFullyQualifiedDataType, getFullyQualifiedObjectType, getObjectType, getObjectTypeTextRange, setDataType, setObjectType

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

getName, getNameTextRange, setName

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

getAnnotationName, getAstAnnotation, newAnnotation, removeAnnotation

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

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, synchronizeWith

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

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

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

CONVERSION_VALUES_LIST

static final java.lang.String CONVERSION_VALUES_LIST

See Also:

Constant Field Values

DEFAULT_OBJECT_VALUE_PROPERTY

static final java.lang.String DEFAULT_OBJECT_VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

conversionValues

java.util.ListIterator<EclipseLinkConversionValueAnnotation> conversionValues()

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation. Return an empty iterator if the element does not exist in Java.

conversionValuesSize

int conversionValuesSize()

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

conversionValueAt

EclipseLinkConversionValueAnnotation conversionValueAt(int index)

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

indexOfConversionValue

int indexOfConversionValue(EclipseLinkConversionValueAnnotation conversionValue)

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

addConversionValue

EclipseLinkConversionValueAnnotation addConversionValue(int index)

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

moveConversionValue

void moveConversionValue(int targetIndex,
                         int sourceIndex)

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

removeConversionValue

void removeConversionValue(int index)

Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.

getDefaultObjectValue

java.lang.String getDefaultObjectValue()

Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation. Return null if the element does not exist in Java.

setDefaultObjectValue

void setDefaultObjectValue(java.lang.String value)

Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation. Set to null to remove the element.

getDefaultObjectValueTextRange

TextRange getDefaultObjectValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return the TextRange for the 'defaultObjectValue' element. If the element does not exist return the TextRange for the ObjectTypeConverter annotation.