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

All Superinterfaces:

Annotation, JavaResourceNode, Model, NamedConverterAnnotation

public interface StructConverterAnnotation
extends NamedConverterAnnotation

Corresponds to the EclipseLink annotation org.eclipse.persistence.annotations.StructConverter 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	ANNOTATION_NAME
static java.lang.String	CONVERTER_PROPERTY

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

NAME_PROPERTY

Method Summary

java.lang.String	getConverter() Corresponds to the 'converter' element of the StructConverter annotation.
TextRange	getConverterTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'converter' element.
void	setConverter(java.lang.String converter) Corresponds to the 'converter' element of the StructConverter annotation.

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

getName, getNameTextRange, setName

Methods inherited from interface org.eclipse.jpt.core.resource.java.Annotation

getAnnotationName, getJdtAnnotation, newAnnotation, removeAnnotation

Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, update

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

CONVERTER_PROPERTY

static final java.lang.String CONVERTER_PROPERTY

See Also:

Constant Field Values

Method Detail

getConverter

java.lang.String getConverter()

Corresponds to the 'converter' element of the StructConverter annotation. Returns null if the element does not exist in Java.

setConverter

void setConverter(java.lang.String converter)

Corresponds to the 'converter' element of the StructConverter annotation. Set to null to remove the element.

getConverterTextRange

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

Return the TextRange for the 'converter' element. If the element does not exist return the TextRange for the StructConverter annotation.