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

All Superinterfaces:

Annotation, EclipseLinkNamedConverterAnnotation, JavaResourceNode, Model

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

Version:

2.3

Nested Class Summary

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

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	CONVERTER_CLASS_PROPERTY
static java.lang.String	FULLY_QUALIFIED_CONVERTER_CLASS_NAME_PROPERTY

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

NAME_PROPERTY

Method Summary

boolean	converterClassImplementsInterface(java.lang.String interfaceName, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the converter class implements the specified interface.
java.lang.String	getConverterClass() Corresponds to the 'converterClass' element of the Converter annotation.
TextRange	getConverterClassTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'converterClass' element.
java.lang.String	getFullyQualifiedConverterClassName() Return the fully-qualified customizer class name as resolved by the AST's bindings.
void	setConverterClass(java.lang.String value) Corresponds to the 'converterClass' element of the Converter annotation.

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

getName, getNameTextRange, setName

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

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

CONVERTER_CLASS_PROPERTY

static final java.lang.String CONVERTER_CLASS_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_CONVERTER_CLASS_NAME_PROPERTY

static final java.lang.String FULLY_QUALIFIED_CONVERTER_CLASS_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getConverterClass

java.lang.String getConverterClass()

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

setConverterClass

void setConverterClass(java.lang.String value)

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

getFullyQualifiedConverterClassName

java.lang.String getFullyQualifiedConverterClassName()

Return the fully-qualified customizer class name as resolved by the AST's bindings.

     @Converter(GenderConverter.class)
 

will return "model.GenderConverter" if there is an import for model.GenderConverter.

Returns:

getConverterClassTextRange

TextRange getConverterClassTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

converterClassImplementsInterface

boolean converterClassImplementsInterface(java.lang.String interfaceName,
                                          org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return whether the converter class implements the specified interface.

See Also:

EclipseLinkCustomConverter.ECLIPSELINK_CONVERTER_CLASS_NAME