org.eclipse.jpt.jaxb.eclipselink.core.resource.java
Interface XmlJoinNodeAnnotation

All Superinterfaces:

Annotation, JavaResourceModel, Model, NestableAnnotation

public interface XmlJoinNodeAnnotation
extends NestableAnnotation

Corresponds to the Oxm annotation org.eclipse.persistence.oxm.annotations.XmlJoinNode 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.2

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	REFERENCED_XML_PATH_PROPERTY String associated with change events to the 'referencedXmlPath' property
static String	XML_PATH_PROPERTY String associated with change events to the 'xmlPath' property

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

FILE_TRANSFORMER

Method Summary

String	getReferencedXmlPath() Corresponds to the 'referencedXmlPath' element of the XmlJoinNode annotation.
TextRange	getReferencedXmlPathTextRange() Return the text range associated with the 'referencedXmlPath' element.
TextRange	getReferencedXmlPathValidationTextRange() Return the text range associated with the 'referencedXmlPath' element.
String	getXmlPath() Corresponds to the 'xmlPath' element of the XmlJoinNode annotation.
TextRange	getXmlPathTextRange() Return the text range associated with the 'xmlPath' element.
TextRange	getXmlPathValidationTextRange() Return the text range associated with the 'xmlPath' element.
boolean	referencedXmlPathTouches(int pos) Return whether the specified text position is within the 'referencedXmlPath' element.
void	setReferencedXmlPath(String referencedXmlPath) Corresponds to the 'referencedXmlPath' element of the XmlJoinNode annotation.
void	setXmlPath(String xmlPath) Corresponds to the 'xmlPath' element of the XmlJoinNode annotation.
boolean	xmlPathTouches(int pos) Return whether the specified text position is within the 'xmlPath' element.

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.NestableAnnotation

moveAnnotation

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

XML_PATH_PROPERTY

static final String XML_PATH_PROPERTY

String associated with change events to the 'xmlPath' property

See Also:

Constant Field Values

REFERENCED_XML_PATH_PROPERTY

static final String REFERENCED_XML_PATH_PROPERTY

String associated with change events to the 'referencedXmlPath' property

See Also:

Constant Field Values

Method Detail

getXmlPath

String getXmlPath()

Corresponds to the 'xmlPath' element of the XmlJoinNode annotation. Return null if the element does not exist in Java.

setXmlPath

void setXmlPath(String xmlPath)

Corresponds to the 'xmlPath' element of the XmlJoinNode annotation. Set to null to remove the element.

getXmlPathTextRange

TextRange getXmlPathTextRange()

Return the text range associated with the 'xmlPath' element. Return null if the element is absent.

getXmlPathValidationTextRange

TextRange getXmlPathValidationTextRange()

Return the text range associated with the 'xmlPath' element. Return the text range of this annotation if the element is absent.

xmlPathTouches

boolean xmlPathTouches(int pos)

Return whether the specified text position is within the 'xmlPath' element. Return false if the element is absent.

getReferencedXmlPath

String getReferencedXmlPath()

Corresponds to the 'referencedXmlPath' element of the XmlJoinNode annotation. Return null if the element does not exist in Java.

setReferencedXmlPath

void setReferencedXmlPath(String referencedXmlPath)

Corresponds to the 'referencedXmlPath' element of the XmlJoinNode annotation. Set to null to remove the element.

getReferencedXmlPathTextRange

TextRange getReferencedXmlPathTextRange()

Return the text range associated with the 'referencedXmlPath' element. Return null if the element is absent.

getReferencedXmlPathValidationTextRange

TextRange getReferencedXmlPathValidationTextRange()

Return the text range associated with the 'referencedXmlPath' element. Return the text range of this annotation if the element is absent.

referencedXmlPathTouches

boolean referencedXmlPathTouches(int pos)

Return whether the specified text position is within the 'referencedXmlPath' element. Return null if the element is absent.