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

All Superinterfaces:
Annotation, JavaResourceNode, Model, OwnableRelationshipMappingAnnotation, RelationshipMappingAnnotation

public interface OneToOneAnnotation
extends OwnableRelationshipMappingAnnotation

Corresponds to the JPA annotation javax.persistence.OneToOne 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.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
JavaResourceNode.Root
 
Field Summary
static java.lang.String ANNOTATION_NAME
           
static java.lang.String OPTIONAL_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.core.resource.java.OwnableRelationshipMappingAnnotation
MAPPED_BY_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_QUALIFIED_TARGET_ENTITY_CLASS_NAME_PROPERTY, TARGET_ENTITY_PROPERTY
 
Method Summary
 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.
 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.OwnableRelationshipMappingAnnotation
getMappedBy, getMappedByTextRange, mappedByTouches, setMappedBy
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.RelationshipMappingAnnotation
getCascadeTextRange, getFetch, getFetchTextRange, getFullyQualifiedTargetEntityClassName, getTargetEntity, getTargetEntityTextRange, isCascadeAll, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, setCascadeAll, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setFetch, setTargetEntity
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.Annotation
getAnnotationName, getJdtAnnotation, newAnnotation, removeAnnotation
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, update
 
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
Method Detail

getOptional

java.lang.Boolean getOptional()
Corresponds to the 'optional' element of the OneToOne annotation. Return null if the 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 element.


getOptionalTextRange

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