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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

ReadTransformerAnnotation, WriteTransformerAnnotation

public interface TransformerAnnotation
extends Annotation

Common protocol among: org.eclipse.persistence.annotations.ReadTransformer org.eclipse.persistence.annotations.WriteTransformer 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	METHOD_PROPERTY
static java.lang.String	TRANSFORMER_CLASS_PROPERTY

Method Summary

java.lang.String	getMethod() Corresponds to the 'method' element of the *Transformer annotation.
TextRange	getMethodTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'method' element.
java.lang.String	getTransformerClass() Corresponds to the 'transformerClass' element of the *Transformer annotation.
TextRange	getTransformerClassTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'transformerClass' element.
void	setMethod(java.lang.String method) Corresponds to the 'method' element of the *Transformer annotation.
void	setTransformerClass(java.lang.String transformerClass) Corresponds to the 'transformerClass' element of the *Transformer annotation.

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

TRANSFORMER_CLASS_PROPERTY

static final java.lang.String TRANSFORMER_CLASS_PROPERTY

See Also:

Constant Field Values

METHOD_PROPERTY

static final java.lang.String METHOD_PROPERTY

See Also:

Constant Field Values

Method Detail

getTransformerClass

java.lang.String getTransformerClass()

Corresponds to the 'transformerClass' element of the *Transformer annotation. Return null if the element does not exist in Java. Return the portion of the value preceding ".class".

     @ReadTransformer(transformerClass=Employee.class)
 

will return "Employee".

setTransformerClass

void setTransformerClass(java.lang.String transformerClass)

Corresponds to the 'transformerClass' element of the *Transformer annotation. Set to null to remove the element.

getTransformerClassTextRange

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

Return the TextRange for the 'transformerClass' element. If the element does not exist return the TextRange for the *Transformer annotation.

getMethod

java.lang.String getMethod()

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

setMethod

void setMethod(java.lang.String method)

Corresponds to the 'method' element of the *Transformer annotation. Set to null to remove the element.

getMethodTextRange

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

Return the TextRange for the 'method' element. If the element does not exist return the TextRange for the *Transformer annotation.