org.eclipse.jpt.jpa.core.jpa2.resource.java
Interface GeneratedAnnotation

All Superinterfaces:
Annotation, JavaResourceNode, Model

public interface GeneratedAnnotation
extends Annotation

Corresponds to the Java 6 annotation javax.annotation.Generated

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.3
Version:
2.3

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 COMMENTS_ELEMENT_NAME
           
static java.lang.String COMMENTS_PROPERTY
           
static java.lang.String DATE_ELEMENT_NAME
           
static java.lang.String DATE_PROPERTY
           
static java.lang.String VALUE_ELEMENT_NAME
           
static java.lang.String VALUES_LIST
           
 
Method Summary
 void addValue(int index, java.lang.String value)
          Corresponds to the value element of the Generated annotation.
 void addValue(java.lang.String value)
          Corresponds to the value element of the Generated annotation.
 java.lang.String getComments()
          Corresponds to the comments element of the Generated annotation.
 java.lang.String getDate()
          Corresponds to the date element of the Generated annotation.
 java.lang.String getValue(int index)
          Corresponds to the value element of the Generated annotation.
 void moveValue(int targetIndex, int sourceIndex)
          Corresponds to the value element of the Generated annotation.
 void removeValue(int index)
          Corresponds to the value element of the Generated annotation.
 void removeValue(java.lang.String value)
          Corresponds to the value element of the Generated annotation.
 void setComments(java.lang.String comments)
          Corresponds to the comments element of the Generated annotation.
 void setDate(java.lang.String date)
          Corresponds to the date element of the Generated annotation.
 java.util.ListIterator<java.lang.String> values()
          Corresponds to the value element of the Generated annotation.
 int valuesSize()
          Corresponds to the value element of the Generated 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

VALUE_ELEMENT_NAME

static final java.lang.String VALUE_ELEMENT_NAME
See Also:
Constant Field Values

DATE_ELEMENT_NAME

static final java.lang.String DATE_ELEMENT_NAME
See Also:
Constant Field Values

COMMENTS_ELEMENT_NAME

static final java.lang.String COMMENTS_ELEMENT_NAME
See Also:
Constant Field Values

VALUES_LIST

static final java.lang.String VALUES_LIST
See Also:
Constant Field Values

DATE_PROPERTY

static final java.lang.String DATE_PROPERTY
See Also:
Constant Field Values

COMMENTS_PROPERTY

static final java.lang.String COMMENTS_PROPERTY
See Also:
Constant Field Values
Method Detail

values

java.util.ListIterator<java.lang.String> values()
Corresponds to the value element of the Generated annotation. Return null if the element does not exist in the annotation.


valuesSize

int valuesSize()
Corresponds to the value element of the Generated annotation.


getValue

java.lang.String getValue(int index)
Corresponds to the value element of the Generated annotation.


addValue

void addValue(java.lang.String value)
Corresponds to the value element of the Generated annotation.


addValue

void addValue(int index,
              java.lang.String value)
Corresponds to the value element of the Generated annotation.


moveValue

void moveValue(int targetIndex,
               int sourceIndex)
Corresponds to the value element of the Generated annotation.


removeValue

void removeValue(java.lang.String value)
Corresponds to the value element of the Generated annotation.


removeValue

void removeValue(int index)
Corresponds to the value element of the Generated annotation.


getDate

java.lang.String getDate()
Corresponds to the date element of the Generated annotation. Return null if the element does not exist in the annotation.


setDate

void setDate(java.lang.String date)
Corresponds to the date element of the Generated annotation. Set to null to remove the element.


getComments

java.lang.String getComments()
Corresponds to the comments element of the Generated annotation. Return null if the element does not exist in the annotation.


setComments

void setComments(java.lang.String comments)
Corresponds to the comments element of the Generated annotation. Set to null to remove the element.