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

All Superinterfaces:
Annotation, JavaResourceNode, Model, NestableAnnotation

public interface XmlNsAnnotation
extends NestableAnnotation

Corresponds to the JAXB annotation javax.xml.bind.annotation.XmlNs 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 NAMESPACE_URI_PROPERTY
           
static java.lang.String PREFIX_PROPERTY
           
 
Method Summary
 java.lang.String getNamespaceURI()
          Corresponds to the 'namespaceURI' element of the XmlNs annotation.
 TextRange getNamespaceURITextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'namespace' element.
 java.lang.String getPrefix()
          Corresponds to the 'prefix' element of the XmlNs annotation.
 TextRange getPrefixTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the 'prefix' element.
 void setNamespaceURI(java.lang.String namespaceURI)
          Corresponds to the 'namespaceURI' element of the XmlNs annotation.
 void setPrefix(java.lang.String prefix)
          Corresponds to the 'prefix' element of the XmlNs 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

NAMESPACE_URI_PROPERTY

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

PREFIX_PROPERTY

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

getNamespaceURI

java.lang.String getNamespaceURI()
Corresponds to the 'namespaceURI' element of the XmlNs annotation. Return null if the element does not exist in Java.


setNamespaceURI

void setNamespaceURI(java.lang.String namespaceURI)
Corresponds to the 'namespaceURI' element of the XmlNs annotation. Set to null to remove the element.


getNamespaceURITextRange

TextRange getNamespaceURITextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'namespace' element. If the element does not exist return the TextRange for the XmlNs annotation.


getPrefix

java.lang.String getPrefix()
Corresponds to the 'prefix' element of the XmlNs annotation. Return null if the element does not exist in Java.


setPrefix

void setPrefix(java.lang.String prefix)
Corresponds to the 'prefix' element of the XmlNs annotation. Set to null to remove the element.


getPrefixTextRange

TextRange getPrefixTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the 'prefix' element. If the element does not exist return the TextRange for the XmlNs annotation.