org.eclipse.jpt.core.resource.java
Interface OneToOneAnnotation

All Superinterfaces:
JavaResourceNode, Model, RelationshipMappingAnnotation

public interface OneToOneAnnotation
extends RelationshipMappingAnnotation

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.


Field Summary
static java.lang.String ANNOTATION_NAME
           
static java.lang.String MAPPED_BY_PROPERTY
           
static java.lang.String OPTIONAL_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.core.resource.java.RelationshipMappingAnnotation
CASCADE_ALL_PROPERTY, CASCADE_MERGE_PROPERTY, CASCADE_PERSIST_PROPERTY, CASCADE_REFRESH_PROPERTY, CASCADE_REMOVE_PROPERTY, FETCH_PROPERTY, FULLY_QUALFIEID_TARGET_ENTITY_PROPERTY, TARGET_ENTITY_PROPERTY
 
Method Summary
 java.lang.String getMappedBy()
          Corresponds to the mappedBy element of the OneToOne annotation.
 TextRange getMappedByTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the mappedBy element.
 java.lang.Boolean getOptional()
          Corresponds to the optional element of the OneToOne annotation.
 TextRange getOptionalTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the optional element.
 boolean mappedByTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified postition touches the mappedBy element.
 void setMappedBy(java.lang.String mappedBy)
          Corresponds to the mappedBy element of the OneToOne annotation.
 void setOptional(java.lang.Boolean optional)
          Corresponds to the optional element of the OneToOne annotation.
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.RelationshipMappingAnnotation
getCascadeTextRange, getFetch, getFetchTextRange, getFullyQualifiedTargetEntity, getTargetEntity, getTargetEntityTextRange, isCascadeAll, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, setCascadeAll, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setFetch, setTargetEntity
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
getJpaCompilationUnit, getResourceModel, getTextRange, initialize, updateFromJava
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener
 

Field Detail

ANNOTATION_NAME

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

OPTIONAL_PROPERTY

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

MAPPED_BY_PROPERTY

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

getOptional

java.lang.Boolean getOptional()
Corresponds to the optional element of the OneToOne annotation. Returns null if the optional element does not exist in java.


setOptional

void setOptional(java.lang.Boolean optional)
Corresponds to the optional element of the OneToOne annotation. Set to null to remove the optional element.


getMappedBy

java.lang.String getMappedBy()
Corresponds to the mappedBy element of the OneToOne annotation. Returns null if the mappedBy element does not exist in java.


setMappedBy

void setMappedBy(java.lang.String mappedBy)
Corresponds to the mappedBy element of the OneToOne annotation. Set to null to remove the mappedBy element.


getMappedByTextRange

TextRange getMappedByTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the mappedBy element. If the mappedBy element does not exist return the TextRange for the OneToOne annotation.


getOptionalTextRange

TextRange getOptionalTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the optional element. If the optional element does not exist return the TextRange for the OneToOne annotation.


mappedByTouches

boolean mappedByTouches(int pos,
                        org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified postition touches the mappedBy element. Return false if the mappedBy element does not exist.