org.eclipse.jpt.jpa.core.resource.java
Interface UniqueConstraintAnnotation

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

NestableUniqueConstraintAnnotation

public interface UniqueConstraintAnnotation
extends Annotation

Corresponds to the JPA annotation javax.persistence.UniqueConstraint 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.0

Version:

2.2

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	COLUMN_NAMES_LIST

Method Summary

void	addColumnName(int index, java.lang.String columnName) Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
void	addColumnName(java.lang.String columnName) Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
java.util.ListIterator<java.lang.String>	columnNames() Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
int	columnNamesSize() Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
boolean	columnNamesTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'columnNames' element.
void	moveColumnName(int targetIndex, int sourceIndex) Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
void	removeColumnName(int index) Corresponds to the 'columnNames' element of the UniqueConstraint annotation.
void	removeColumnName(java.lang.String columnName) Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

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

getAnnotationName, getAstAnnotation, isUnset, newAnnotation, removeAnnotation, restoreFrom, storeOn

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

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange, initialize, synchronizeWith

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

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

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

COLUMN_NAMES_LIST

static final java.lang.String COLUMN_NAMES_LIST

See Also:

Constant Field Values

Method Detail

columnNames

java.util.ListIterator<java.lang.String> columnNames()

Corresponds to the 'columnNames' element of the UniqueConstraint annotation. Return null if the element does not exist in the annotation.

columnNamesSize

int columnNamesSize()

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

addColumnName

void addColumnName(java.lang.String columnName)

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

addColumnName

void addColumnName(int index,
                   java.lang.String columnName)

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

moveColumnName

void moveColumnName(int targetIndex,
                    int sourceIndex)

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

removeColumnName

void removeColumnName(java.lang.String columnName)

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

removeColumnName

void removeColumnName(int index)

Corresponds to the 'columnNames' element of the UniqueConstraint annotation.

columnNamesTouches

boolean columnNamesTouches(int pos,
                           org.eclipse.jdt.core.dom.CompilationUnit astRoot)

Return whether the specified position touches the 'columnNames' element. Return false if the element does not exist.