Dali Provisional API
Release 3.2

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

All Superinterfaces:
Annotation, JavaResourceModel, Model
All Known Subinterfaces:
DbGeneratorAnnotation, SequenceGeneratorAnnotation, SequenceGeneratorAnnotation2_0, TableGeneratorAnnotation, UuidGeneratorAnnotation2_4

public interface GeneratorAnnotation
extends Annotation

Common protocol among:

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

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel
JavaResourceModel.FileTransformer, JavaResourceModel.Root
 
Field Summary
static String NAME_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel
FILE_TRANSFORMER
 
Method Summary
 String getName()
          Corresponds to the 'name' element of the *Generator annotation.
 TextRange getNameTextRange()
          Return the TextRange for the 'name' element.
 void setName(String name)
          Corresponds to the 'name' element of the *Generator 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.JavaResourceModel
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

NAME_PROPERTY

static final String NAME_PROPERTY
See Also:
Constant Field Values
Method Detail

getName

String getName()
Corresponds to the 'name' element of the *Generator annotation. Return null if the element does not exist in Java.


setName

void setName(String name)
Corresponds to the 'name' element of the *Generator annotation. Set to null to remove the element.


getNameTextRange

TextRange getNameTextRange()
Return the TextRange for the 'name' element. If the element does not exist return the TextRange for the *Generator annotation.


Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.