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

All Superinterfaces:

Annotation, EclipseLinkTransformerAnnotation, JavaResourceNode, Model

public interface EclipseLinkWriteTransformerAnnotation
extends EclipseLinkTransformerAnnotation

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

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	ANNOTATION_NAME
static String	COLUMN_PROPERTY

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

METHOD_PROPERTY, TRANSFORMER_CLASS_PROPERTY

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

FILE_TRANSFORMER

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() 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.jpa.eclipselink.core.resource.java.EclipseLinkTransformerAnnotation

getMethod, getMethodTextRange, getTransformerClass, getTransformerClassTextRange, setMethod, setTransformerClass

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

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

COLUMN_PROPERTY

static final 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()

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