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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

EclipseLinkReadTransformerAnnotation, EclipseLinkWriteTransformerAnnotation

public interface EclipseLinkTransformerAnnotation
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

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	METHOD_PROPERTY
static String	TRANSFORMER_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

FILE_TRANSFORMER

Method Summary

String	getMethod() Corresponds to the 'method' element of the *Transformer annotation.
TextRange	getMethodTextRange() Return the TextRange for the 'method' element.
String	getTransformerClass() Corresponds to the 'transformerClass' element of the *Transformer annotation.
TextRange	getTransformerClassTextRange() Return the TextRange for the 'transformerClass' element.
void	setMethod(String method) Corresponds to the 'method' element of the *Transformer annotation.
void	setTransformerClass(String transformerClass) Corresponds to the 'transformerClass' element of the *Transformer annotation.

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

TRANSFORMER_CLASS_PROPERTY

static final String TRANSFORMER_CLASS_PROPERTY

See Also:

Constant Field Values

METHOD_PROPERTY

static final String METHOD_PROPERTY

See Also:

Constant Field Values

Method Detail

getTransformerClass

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(String transformerClass)

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

getTransformerClassTextRange

TextRange getTransformerClassTextRange()

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

getMethod

String getMethod()

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

setMethod

void setMethod(String method)

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

getMethodTextRange

TextRange getMethodTextRange()

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