Dali Provisional API
Release 3.2

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

All Superinterfaces:
Annotation, EclipseLinkNamedConverterAnnotation, JavaResourceNode, Model, NestableAnnotation

public interface EclipseLinkConverterAnnotation
extends EclipseLinkNamedConverterAnnotation

Corresponds to the EclipseLink annotation org.eclipse.persistence.annotations.Converter

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 ANNOTATION_NAME
           
static String CONVERTER_CLASS_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.jpa.eclipselink.core.resource.java.EclipseLinkNamedConverterAnnotation
NAME_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode
FILE_TRANSFORMER
 
Method Summary
 String getConverterClass()
          Corresponds to the 'converterClass' element of the Converter annotation.
 TextRange getConverterClassTextRange()
          Return the TextRange for the 'converterClass' element.
 String getFullyQualifiedConverterClassName()
          Return the fully-qualified converter class name as resolved by the AST's bindings.
 void setConverterClass(String value)
          Corresponds to the 'converterClass' element of the Converter annotation.
 
Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.resource.java.EclipseLinkNamedConverterAnnotation
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.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

ANNOTATION_NAME

static final String ANNOTATION_NAME
See Also:
Constant Field Values

CONVERTER_CLASS_PROPERTY

static final String CONVERTER_CLASS_PROPERTY
See Also:
Constant Field Values
Method Detail

getConverterClass

String getConverterClass()
Corresponds to the 'converterClass' element of the Converter annotation. Returns null if the element does not exist in java.


setConverterClass

void setConverterClass(String value)
Corresponds to the 'converterClass' element of the Converter annotation. Set to null to remove the element.


getFullyQualifiedConverterClassName

String getFullyQualifiedConverterClassName()
Return the fully-qualified converter class name as resolved by the AST's bindings.
     @Converter(GenderConverter.class)
 
will return "model.GenderConverter" if there is an import for model.GenderConverter.


getConverterClassTextRange

TextRange getConverterClassTextRange()
Return the TextRange for the 'converterClass' element. If the element does not exist return the TextRange for the Converter annotation.


Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.