XmlSeeAlsoAnnotation (Dali Java Persistence Tools Doc)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

Dali Provisional API
Release 3.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jpt.jaxb.core.resource.java
Interface XmlSeeAlsoAnnotation

All Superinterfaces:: Annotation, JavaResourceModel, Model

public interface XmlSeeAlsoAnnotation
extends Annotation
extends Annotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlSeeAlso 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:: 3.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`	`CLASSES_LIST` Change notification constant associated with the value element
`static String`	`FULLY_QUALIFIED_CLASSES_LIST` Change notification constant associated with the fully qualified classes.

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

Method Summary
`void`	`addClass(int index, String clazz)` Corresponds to the 'value' element of the XmlSeeAlso annotation.
`void`	`addClass(String clazz)` Corresponds to the 'value' element of the XmlSeeAlso annotation.
`org.eclipse.jpt.common.utility.iterable.ListIterable<String>`	`getClasses()` Corresponds to the 'value' element of the XmlSeeAlso annotation.
`int`	`getClassesSize()` Corresponds to the 'value' element of the XmlSeeAlso annotation.
`org.eclipse.jpt.common.utility.iterable.ListIterable<String>`	`getFullyQualifiedClasses()` Return the value elements resolved to fully qualified class names
`void`	`moveClass(int targetIndex, int sourceIndex)` Corresponds to the 'value' element of the XmlSeeAlso annotation.
`void`	`removeClass(int index)` Corresponds to the 'value' element of the XmlSeeAlso 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

CLASSES_LIST

static final String CLASSES_LIST

Change notification constant associated with the value element

See Also:: Constant Field Values

FULLY_QUALIFIED_CLASSES_LIST

static final String FULLY_QUALIFIED_CLASSES_LIST

Change notification constant associated with the fully qualified classes. Changes should occur whenever changes occur to the "classes" list, but may also occur with changes to the classes resolution state (import changes, e.g.)

See Also:: Constant Field Values

Method Detail

getClasses

org.eclipse.jpt.common.utility.iterable.ListIterable<String> getClasses()

Corresponds to the 'value' element of the XmlSeeAlso annotation. Return an empty iterator if the element does not exist in Java. Return the portion of the value preceding ".class".

     @XmlSeeAlso({Foo.class, Bar.class})

will return and iterable containing: "Foo", "Bar"