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

All Superinterfaces:

Annotation, JavaResourceNode, Model, TransformerAnnotation

public interface WriteTransformerAnnotation
extends TransformerAnnotation

Corresponds to the Eclipselink annotation 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	ANNOTATION_NAME
static java.lang.String	COLUMN_PROPERTY

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

METHOD_PROPERTY, TRANSFORMER_CLASS_PROPERTY

Method Summary

ColumnAnnotation	addColumn() Add the 'column' element to the WriteTransformer annotation.
ColumnAnnotation	getColumn() Corresponds to the 'column' element of the WriteTransformer annotation.
TextRange	getColumnTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'column' element.
ColumnAnnotation	getNonNullColumn() Return a ColumnAnnotation, but do not return null if the 'column' element does not exist on the WriteTransformer annotation.
void	removeColumn() Remove the 'column' element from the WriteTransformer annotation.

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

getMethod, getMethodTextRange, getTransformerClass, getTransformerClassTextRange, setMethod, setTransformerClass

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

COLUMN_PROPERTY

static final java.lang.String COLUMN_PROPERTY

See Also:

Constant Field Values

Method Detail

getColumn

ColumnAnnotation getColumn()

Corresponds to the 'column' element of the WriteTransformer annotation. Return null if the element does not exist in Java.

getNonNullColumn

ColumnAnnotation getNonNullColumn()

Return a ColumnAnnotation, but do not return null if the 'column' element does not exist on the WriteTransformer annotation. Instead return a null object.

addColumn

ColumnAnnotation addColumn()

Add the 'column' element to the WriteTransformer annotation.

removeColumn

void removeColumn()

Remove the 'column' element from the WriteTransformer annotation.

getColumnTextRange

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

Return the TextRange for the 'column' element. If the element does not exist return the TextRange for the WriteTransformer annotation.