org.eclipse.jpt.common.core.resource.java
Interface Annotation

All Superinterfaces:

JavaResourceModel, Model

All Known Subinterfaces:

AccessAnnotation2_0, ArrayAnnotation2_3, AssociationOverrideAnnotation, AssociationOverrideAnnotation2_0, AttributeOverrideAnnotation, BaseColumnAnnotation, BaseConvertAnnotation, BaseEnumeratedAnnotation, BaseJoinColumnAnnotation, BaseTableAnnotation, BaseTemporalAnnotation, BaseTypeConverterAnnotation, BasicAnnotation, BasicCollectionAnnotation, BasicMapAnnotation, CacheableAnnotation2_0, CacheAnnotation, ChangeTrackingAnnotation, ClassExtractorAnnotation2_1, CollectionTableAnnotation2_0, ColumnAnnotation, CompleteColumnAnnotation, CompleteJoinColumnAnnotation, ConversionValueAnnotation, ConvertAnnotation, ConverterAnnotation, CustomizerAnnotation, DbGeneratorAnnotation, DiscriminatorColumnAnnotation, DiscriminatorValueAnnotation, ElementCollectionAnnotation2_0, EmbeddableAnnotation, EmbeddedAnnotation, EmbeddedIdAnnotation, EntityAnnotation, EnumeratedAnnotation, ExistenceCheckingAnnotation, GeneratedAnnotation2_0, GeneratedValueAnnotation, GeneratorAnnotation, IdAnnotation, IdClassAnnotation, InheritanceAnnotation, JaxbBasicSchemaComponentAnnotation, JoinColumnAnnotation, JoinFetchAnnotation, JoinTableAnnotation, LobAnnotation, ManyToManyAnnotation, ManyToManyAnnotation2_0, ManyToOneAnnotation, ManyToOneAnnotation2_0, MapKeyAnnotation, MapKeyClassAnnotation2_0, MapKeyColumnAnnotation2_0, MapKeyConvertAnnotation2_0, MapKeyEnumeratedAnnotation2_0, MapKeyJoinColumnAnnotation2_0, MapKeyTemporalAnnotation2_0, MappedSuperclassAnnotation, MapsIdAnnotation2_0, MultitenantAnnotation2_3, MutableAnnotation, NamedColumnAnnotation, NamedConverterAnnotation, NamedNativeQueryAnnotation, NamedQueryAnnotation, NamedQueryAnnotation2_0, NestableAnnotation, ObjectTypeConverterAnnotation, OneToManyAnnotation, OneToManyAnnotation2_0, OneToOneAnnotation, OneToOneAnnotation2_0, OrderByAnnotation, OrderColumnAnnotation2_0, OverrideAnnotation, OwnableRelationshipMappingAnnotation, OwningRelationshipMappingAnnotation2_0, PrimaryKeyAnnotation, PrimaryKeyJoinColumnAnnotation, PrivateOwnedAnnotation, QNameAnnotation, QueryAnnotation, QueryHintAnnotation, ReadOnlyAnnotation, ReadTransformerAnnotation, ReferenceTableAnnotation, RelationshipMappingAnnotation, RelationshipMappingAnnotation2_0, SecondaryTableAnnotation, SequenceGeneratorAnnotation, SequenceGeneratorAnnotation2_0, SingleRelationshipMappingAnnotation, StaticMetamodelAnnotation2_0, StructConverterAnnotation, StructureAnnotation2_3, TableAnnotation, TableGeneratorAnnotation, TemporalAnnotation, TenantDiscriminatorColumnAnnotation2_3, TimeOfDayAnnotation, TransformationAnnotation, TransformerAnnotation, TransientAnnotation, TypeConverterAnnotation, UniqueConstraintAnnotation, UuidGeneratorAnnotation2_4, VariableOneToOneAnnotation, VersionAnnotation, WriteTransformerAnnotation, XmlAccessorOrderAnnotation, XmlAccessorTypeAnnotation, XmlAnyAttributeAnnotation, XmlAnyElementAnnotation, XmlAttachmentRefAnnotation, XmlAttributeAnnotation, XmlCDATAAnnotation, XmlDiscriminatorNodeAnnotation, XmlDiscriminatorValueAnnotation, XmlElementAnnotation, XmlElementDeclAnnotation, XmlElementRefAnnotation, XmlElementRefsAnnotation, XmlElementsAnnotation, XmlElementWrapperAnnotation, XmlEnumAnnotation, XmlEnumValueAnnotation, XmlIDAnnotation, XmlIDREFAnnotation, XmlInlineBinaryDataAnnotation, XmlInverseReferenceAnnotation, XmlJavaTypeAdapterAnnotation, XmlJoinNodeAnnotation, XmlKeyAnnotation, XmlListAnnotation, XmlMimeTypeAnnotation, XmlMixedAnnotation, XmlNsAnnotation, XmlPathAnnotation, XmlRegistryAnnotation, XmlRootElementAnnotation, XmlSchemaAnnotation, XmlSchemaTypeAnnotation, XmlSeeAlsoAnnotation, XmlTransformationAnnotation, XmlTransientAnnotation, XmlTypeAnnotation, XmlValueAnnotation

public interface Annotation
extends JavaResourceModel

Common Java resource annotation behavior 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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

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

FILE_TRANSFORMER

Method Summary

String	getAnnotationName() Return the annotation's fully qualified name, as opposed to the value of the annotation's 'name' element.
Annotation	getAstAnnotation(CompilationUnit astRoot) Return the corresponding JDT DOM annotation from the specified AST compilation unit.
void	initialize(Annotation astAnnotation) Initialize the [source] node from the specified AST annotation.
void	initialize(CompilationUnit astRoot) Initialize the [source] node from the specified AST.
boolean	isUnset() Return whether all the annotation's member values are null; implying the annotation can be removed if it has no semantic value as a marker annotation.
void	newAnnotation() Create and add the corresponding Java annotation to the JDT DOM.
void	removeAnnotation() Remove the corresponding Java annotation from the JDT DOM.
void	synchronizeWith(Annotation astAnnotation) Synchronize the [source] node with the specified AST annotation.
void	synchronizeWith(CompilationUnit astRoot) Synchronize the [source] node with the specified AST.

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

Method Detail

initialize

void initialize(CompilationUnit astRoot)

Initialize the [source] node from the specified AST.

synchronizeWith

void synchronizeWith(CompilationUnit astRoot)

Synchronize the [source] node with the specified AST.

initialize

void initialize(Annotation astAnnotation)

Initialize the [source] node from the specified AST annotation.

synchronizeWith

void synchronizeWith(Annotation astAnnotation)

Synchronize the [source] node with the specified AST annotation.

getAnnotationName

String getAnnotationName()

Return the annotation's fully qualified name, as opposed to the value of the annotation's 'name' element. For example:

getAstAnnotation

Annotation getAstAnnotation(CompilationUnit astRoot)

Return the corresponding JDT DOM annotation from the specified AST compilation unit.

newAnnotation

void newAnnotation()

Create and add the corresponding Java annotation to the JDT DOM.
Internal to the java resource model.

See Also:

JavaResourceAnnotatedElement.addAnnotation(String)

removeAnnotation

void removeAnnotation()

Remove the corresponding Java annotation from the JDT DOM.
Internal to the java resource model.

See Also:

JavaResourceAnnotatedElement.removeAnnotation(String)

isUnset

boolean isUnset()

Return whether all the annotation's member values are null; implying the annotation can be removed if it has no semantic value as a marker annotation.