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

All Superinterfaces:

Annotation, BaseTypeConverterAnnotation, JavaResourceModel, Model, NamedConverterAnnotation, NestableAnnotation

public interface ObjectTypeConverterAnnotation
extends BaseTypeConverterAnnotation

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

Nested Class Summary

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

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String	ANNOTATION_NAME
static String	CONVERSION_VALUES_LIST
static String	DEFAULT_OBJECT_VALUE_PROPERTY

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

DATA_TYPE_PROPERTY, OBJECT_TYPE_PROPERTY

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

NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

ConversionValueAnnotation	addConversionValue(int index) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
ConversionValueAnnotation	conversionValueAt(int index) Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
org.eclipse.jpt.common.utility.iterable.ListIterable<ConversionValueAnnotation>	getConversionValues() Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
int	getConversionValuesSize() Corresponds to the 'conversionValues' element of the ObjectTypeConverter annotation.
String	getDefaultObjectValue() Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation.
TextRange	getDefaultObjectValueTextRange() Return the TextRange for the 'defaultObjectValue' element.
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(String value) Corresponds to the 'defaultObjectValue' element of the ObjectTypeConverter annotation.

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

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

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

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.JavaResourceModel

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

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

CONVERSION_VALUES_LIST

static final String CONVERSION_VALUES_LIST

See Also:

Constant Field Values

DEFAULT_OBJECT_VALUE_PROPERTY

static final String DEFAULT_OBJECT_VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getConversionValues

org.eclipse.jpt.common.utility.iterable.ListIterable<ConversionValueAnnotation> getConversionValues()

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

getConversionValuesSize

int getConversionValuesSize()

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

conversionValueAt

ConversionValueAnnotation conversionValueAt(int index)

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

addConversionValue

ConversionValueAnnotation 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

String getDefaultObjectValue()

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

setDefaultObjectValue

void setDefaultObjectValue(String value)

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

getDefaultObjectValueTextRange

TextRange getDefaultObjectValueTextRange()

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