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

All Superinterfaces:
Annotation, JavaResourceNode, Model
All Known Subinterfaces:
BaseEclipseLinkTypeConverterAnnotation, EclipseLinkConverterAnnotation, EclipseLinkObjectTypeConverterAnnotation, EclipseLinkStructConverterAnnotation, EclipseLinkTypeConverterAnnotation

public interface EclipseLinkNamedConverterAnnotation
extends Annotation

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
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 NAME_PROPERTY
           
 
Method Summary
 java.lang.String getName()
          Corresponds to the 'name' element of the *Converter annotation.
 TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'name' element.
 void setName(java.lang.String value)
          Corresponds to the 'name' element of the *Converter annotation.
 
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

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Corresponds to the 'name' element of the *Converter annotation. Return null if the element does not exist in Java.


setName

void setName(java.lang.String value)
Corresponds to the 'name' element of the *Converter annotation. Set to null to remove the element.


getNameTextRange

TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'name' element. If the element does not exist return the TextRange for the CustomConverter annotation.