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

All Superinterfaces:

Annotation, JavaResourceModel, Model

All Known Subinterfaces:

ConvertAnnotation, MapKeyConvertAnnotation2_0

public interface BaseConvertAnnotation
extends Annotation

Common protocol among:

• org.eclipse.persistence.annotations.Convert
• org.eclipse.persistence.annotations.MapKeyConvert

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

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String

VALUE_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getValue() Corresponds to the 'value' element of the Convert annotation.
TextRange	getValueTextRange() Return the TextRange for the 'value' element.
void	setValue(String value) Corresponds to the 'value' element of the Convert annotation.
boolean	valueTouches(int pos) Return whether the specified position touches the 'value' element.

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

VALUE_PROPERTY

static final String VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getValue

String getValue()

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

setValue

void setValue(String value)

Corresponds to the 'value' element of the Convert annotation. Set to null to remove the element.

getValueTextRange

TextRange getValueTextRange()

Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the Convert annotation.

valueTouches

boolean valueTouches(int pos)

Return whether the specified position touches the 'value' element. Return false if the element does not exist.