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

All Superinterfaces:

Annotation, JavaResourceNode, Model, NestableAnnotation

All Known Subinterfaces:

EclipseLinkBaseTypeConverterAnnotation, EclipseLinkConverterAnnotation, EclipseLinkObjectTypeConverterAnnotation, EclipseLinkStructConverterAnnotation, EclipseLinkTypeConverterAnnotation

public interface EclipseLinkNamedConverterAnnotation
extends NestableAnnotation

Common protocol among:

• org.eclipse.persistence.annotations.Converter
• org.eclipse.persistence.annotations.StructConverter
• 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.

Since:

2.1

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

NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getName() Corresponds to the 'name' element of the *Converter annotation.
TextRange	getNameTextRange() Return the TextRange for the 'name' element.
void	setName(String value) Corresponds to the 'name' element of the *Converter annotation.

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

NAME_PROPERTY

static final String NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

String getName()

Corresponds to the 'name' element of the *Converter annotation. Return null if the element does not exist in Java.

setName

void setName(String value)

Corresponds to the 'name' element of the *Converter annotation. Set to null to remove the element.

getNameTextRange

TextRange getNameTextRange()

Return the TextRange for the 'name' element. If the element does not exist return the TextRange for the CustomConverter annotation.