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

All Superinterfaces:
Annotation, JavaResourceNode, Model, NestableAnnotation

public interface XmlJavaTypeAdapterAnnotation
extends NestableAnnotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter 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
Version:
3.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jaxb.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Field Summary
static java.lang.String ANNOTATION_NAME
           
static java.lang.String FULLY_QUALIFIED_TYPE_PROPERTY
           
static java.lang.String FULLY_QUALIFIED_VALUE_PROPERTY
           
static java.lang.String TYPE_PROPERTY
           
static java.lang.String VALUE_PROPERTY
           
 
Method Summary
 java.lang.String getFullyQualifiedType()
          Return the type's fully-qualified class name as resolved by the AST's bindings.
 java.lang.String getFullyQualifiedValue()
          Return the value's fully-qualified class name as resolved by the AST's bindings.
 java.lang.String getType()
          Corresponds to the 'type' element of the XmlJavaTypeAdapter annotation.
 TextRange getTypeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'type' element.
 java.lang.String getValue()
          Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation.
 TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'value' element.
 void setType(java.lang.String type)
          Corresponds to the 'type' element of the XmlJavaTypeAdapter annotation.
 void setValue(java.lang.String value)
          Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation.
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.resource.java.NestableAnnotation
moveAnnotation
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.resource.java.Annotation
getAnnotationName, getAstAnnotation, newAnnotation, removeAnnotation
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.resource.java.JavaResourceNode
getFile, getJavaResourceCompilationUnit, 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_PROPERTY

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

FULLY_QUALIFIED_VALUE_PROPERTY

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

TYPE_PROPERTY

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

FULLY_QUALIFIED_TYPE_PROPERTY

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

getValue

java.lang.String getValue()
Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation. Return null if the element does not exist in Java. Return the portion of the value preceding ".class".
     @XmlJavaTypeAdapter(value=FooAdapter.class)
 
will return "FooAdapter"


setValue

void setValue(java.lang.String value)
Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation. Set to null to remove the element.


getValueTextRange

TextRange getValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'value' element. If the element does not exist return the TextRange for the XmlJavaTypeAdapter annotation.


getFullyQualifiedValue

java.lang.String getFullyQualifiedValue()
Return the value's fully-qualified class name as resolved by the AST's bindings.
     @XmlJavaTypeAdapter(FooAdapter.class)
 
will return "example.FooAdapter" if there is an import for example.FooAdapter.


getType

java.lang.String getType()
Corresponds to the 'type' element of the XmlJavaTypeAdapter annotation. Return null if the element does not exist in Java. Return the portion of the value preceding ".class".
     @XmlJavaTypeAdapter(type=Foo.class)
 
will return "Foo"


setType

void setType(java.lang.String type)
Corresponds to the 'type' element of the XmlJavaTypeAdapter annotation. Set to null to remove the element.


getTypeTextRange

TextRange getTypeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'type' element. If the element does not exist return the TextRange for the XmlJavaTypeAdapter annotation.


getFullyQualifiedType

java.lang.String getFullyQualifiedType()
Return the type's fully-qualified class name as resolved by the AST's bindings.
     @XmlJavaTypeAdapter(type=Foo.class)
 
will return "example.Foo" if there is an import for example.Foo.