diff options
| author | Eike Stepper | 2011-09-02 17:40:40 +0000 |
|---|---|---|
| committer | Eike Stepper | 2011-09-02 17:40:40 +0000 |
| commit | 39e55d340b79a835ec815ea688d8f3011506a935 (patch) | |
| tree | 561a25786c263a84b30fd6023ac90096a568f243 /plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html | |
| parent | 43e934e2b6d9df9b72eb229da769ee8954079c61 (diff) | |
| download | cdo-39e55d340b79a835ec815ea688d8f3011506a935.tar.gz cdo-39e55d340b79a835ec815ea688d8f3011506a935.tar.xz cdo-39e55d340b79a835ec815ea688d8f3011506a935.zip | |
update javadoc to juno
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html')
| -rw-r--r-- | plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html index 1207100b09..7f23735cff 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/CDOObject.html @@ -106,9 +106,9 @@ Interface CDOObject</H2> </PRE>
<P>
-A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore"><CODE>EObject</CODE></A> that is exposed by all CDO objects and allows access to special CDO - properties and features of those objects. - <p> +A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore"><CODE>EObject</CODE></A> that is exposed by all CDO objects and allows access to special CDO
+ properties and features of those objects.
+ <p>
Note that, by contract, every instance of CDOObject can also be cast to <A HREF="../../../../org/eclipse/emf/spi/cdo/InternalCDOObject.html" title="interface in org.eclipse.emf.spi.cdo"><CODE>InternalCDOObject</CODE></A>.
<P>
@@ -135,7 +135,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoConflict()">cdoConflict</A></B>()</CODE>
<BR>
- Returns <code>true</code> if this object contains local changes that are conflicting with recognized remote + Returns <code>true</code> if this object contains local changes that are conflicting with recognized remote
changes, <code>false</code> otherwise.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -144,7 +144,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoDirectResource()">cdoDirectResource</A></B>()</CODE>
<BR>
- Returns the directly containing <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, or <code>null</code> if this object is + Returns the directly containing <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, or <code>null</code> if this object is
not an element of the <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#getContents()" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>contents</CODE></A> list of any CDO resource.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -161,7 +161,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoInvalid()">cdoInvalid</A></B>()</CODE>
<BR>
- Returns <code>true</code> if this object is considered as locally invalid (TODO Simon: please briefly explain what + Returns <code>true</code> if this object is considered as locally invalid (TODO Simon: please briefly explain what
this state means) , <code>false</code> otherwise.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -178,7 +178,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoPrefetch(int)">cdoPrefetch</A></B>(int depth)</CODE>
<BR>
- Ensures that the revisions of the contained objects up to the given depth are in the local + Ensures that the revisions of the contained objects up to the given depth are in the local
<A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevisionManager.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision cache</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -203,7 +203,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoResource()">cdoResource</A></B>()</CODE>
<BR>
- Returns the <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, no matter where this object is located in the containment + Returns the <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, no matter where this object is located in the containment
tree of that resource, or <code>null</code> if this object is not contained in a CDO resource.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -212,7 +212,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoRevision()">cdoRevision</A></B>()</CODE>
<BR>
- Returns the <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevision.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision</CODE></A> of this object, or <code>null</code> if this object does currently not + Returns the <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevision.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision</CODE></A> of this object, or <code>null</code> if this object does currently not
have a revision.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -229,7 +229,7 @@ A specialized subinterface of <A HREF="http://download.eclipse.org/modeling/emf/ <TD><CODE><B><A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoView()">cdoView</A></B>()</CODE>
<BR>
- Returns the <A HREF="../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view"><CODE>view</CODE></A> this object is associated with, or <code>null</code> if this object is not + Returns the <A HREF="../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view"><CODE>view</CODE></A> this object is associated with, or <code>null</code> if this object is not
associated with a view.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -285,10 +285,10 @@ cdoID</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/common/id/CDOID.html" title="interface in org.eclipse.emf.cdo.common.id">CDOID</A> <B>cdoID</B>()</PRE>
<DL>
-<DD>Returns the <em>technical</em> object identifier of this object, or <code>null</code> if the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#TRANSIENT"><CODE>TRANSIENT</CODE></A> or <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#INVALID"><CODE>INVALID</CODE></A>. - <p> - If the state of this object is <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#NEW"><CODE>NEW</CODE></A> the returned CDOID instance can be cast to - <A HREF="../../../../org/eclipse/emf/cdo/common/id/CDOIDTemp.html" title="interface in org.eclipse.emf.cdo.common.id"><CODE>CDOIDTemp</CODE></A> and is unique in the scope of the associated <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoView()"><CODE>transaction</CODE></A>. In all other states +<DD>Returns the <em>technical</em> object identifier of this object, or <code>null</code> if the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#TRANSIENT"><CODE>TRANSIENT</CODE></A> or <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#INVALID"><CODE>INVALID</CODE></A>.
+ <p>
+ If the state of this object is <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#NEW"><CODE>NEW</CODE></A> the returned CDOID instance can be cast to
+ <A HREF="../../../../org/eclipse/emf/cdo/common/id/CDOIDTemp.html" title="interface in org.eclipse.emf.cdo.common.id"><CODE>CDOIDTemp</CODE></A> and is unique in the scope of the associated <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoView()"><CODE>transaction</CODE></A>. In all other states
a non-<code>null</code> return value uniquely identifies a persistent object in the scope of the whole repository.
<P>
<DD><DL>
@@ -321,10 +321,10 @@ cdoConflict</H3> <PRE>
boolean <B>cdoConflict</B>()</PRE>
<DL>
-<DD>Returns <code>true</code> if this object contains local changes that are conflicting with recognized remote - changes, <code>false</code> otherwise. - <p> - This method is a convenience method to determine whether the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is either +<DD>Returns <code>true</code> if this object contains local changes that are conflicting with recognized remote
+ changes, <code>false</code> otherwise.
+ <p>
+ This method is a convenience method to determine whether the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is either
<A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#CONFLICT"><CODE>CONFLICT</CODE></A> or <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#INVALID_CONFLICT"><CODE>INVALID_CONFLICT</CODE></A>.
<P>
<DD><DL>
@@ -343,10 +343,10 @@ cdoInvalid</H3> <PRE>
boolean <B>cdoInvalid</B>()</PRE>
<DL>
-<DD>Returns <code>true</code> if this object is considered as locally invalid (TODO Simon: please briefly explain what - this state means) , <code>false</code> otherwise. - <p> - This method is a convenience method to determine whether the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is either +<DD>Returns <code>true</code> if this object is considered as locally invalid (TODO Simon: please briefly explain what
+ this state means) , <code>false</code> otherwise.
+ <p>
+ This method is a convenience method to determine whether the <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoState()"><CODE>state</CODE></A> of this object is either
<A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#INVALID"><CODE>INVALID</CODE></A> or <A HREF="../../../../org/eclipse/emf/cdo/CDOState.html#INVALID_CONFLICT"><CODE>INVALID_CONFLICT</CODE></A>.
<P>
<DD><DL>
@@ -365,7 +365,7 @@ cdoView</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view">CDOView</A> <B>cdoView</B>()</PRE>
<DL>
-<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view"><CODE>view</CODE></A> this object is associated with, or <code>null</code> if this object is not +<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/view/CDOView.html" title="interface in org.eclipse.emf.cdo.view"><CODE>view</CODE></A> this object is associated with, or <code>null</code> if this object is not
associated with a view. This view manages all aspects of this object and cahces it as long as required.
<P>
<DD><DL>
@@ -384,8 +384,8 @@ cdoRevision</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevision.html" title="interface in org.eclipse.emf.cdo.common.revision">CDORevision</A> <B>cdoRevision</B>()</PRE>
<DL>
-<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevision.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision</CODE></A> of this object, or <code>null</code> if this object does currently not - have a revision. The revision is used to store all modeled data of this object, together with some technical data +<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevision.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision</CODE></A> of this object, or <code>null</code> if this object does currently not
+ have a revision. The revision is used to store all modeled data of this object, together with some technical data
required by the framework.
<P>
<DD><DL>
@@ -402,11 +402,11 @@ cdoResource</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource">CDOResource</A> <B>cdoResource</B>()</PRE>
<DL>
-<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, no matter where this object is located in the containment - tree of that resource, or <code>null</code> if this object is not contained in a CDO resource. - <p> - This method may not return <code>null</code> return for objects that have no <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoDirectResource()"><CODE>direct - resource</CODE></A>. Please note that, depending on the containment depth of this object, the evaluation of the resource can +<DD>Returns the <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, no matter where this object is located in the containment
+ tree of that resource, or <code>null</code> if this object is not contained in a CDO resource.
+ <p>
+ This method may not return <code>null</code> return for objects that have no <A HREF="../../../../org/eclipse/emf/cdo/CDOObject.html#cdoDirectResource()"><CODE>direct
+ resource</CODE></A>. Please note that, depending on the containment depth of this object, the evaluation of the resource can
be a costly operation.
<P>
<DD><DL>
@@ -423,10 +423,10 @@ cdoDirectResource</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource">CDOResource</A> <B>cdoDirectResource</B>()</PRE>
<DL>
-<DD>Returns the directly containing <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, or <code>null</code> if this object is - not an element of the <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#getContents()" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>contents</CODE></A> list of any CDO resource. - <p> - Please note that, independend of the containment depth of this object, the evaluation of the direct resource is an +<DD>Returns the directly containing <A HREF="../../../../org/eclipse/emf/cdo/eresource/CDOResource.html" title="interface in org.eclipse.emf.cdo.eresource"><CODE>resource</CODE></A> of this object, or <code>null</code> if this object is
+ not an element of the <A HREF="http://download.eclipse.org/modeling/emf/emf/javadoc/2.7.0/org/eclipse/emf/ecore/resource/Resource.html?is-external=true#getContents()" title="class or interface in org.eclipse.emf.ecore.resource"><CODE>contents</CODE></A> list of any CDO resource.
+ <p>
+ Please note that, independend of the containment depth of this object, the evaluation of the direct resource is an
operation with a constant cost.
<P>
<DD><DL>
@@ -483,14 +483,14 @@ cdoWriteOption</H3> <PRE>
<A HREF="../../../../org/eclipse/emf/cdo/CDOLock.html" title="interface in org.eclipse.emf.cdo">CDOLock</A> <B>cdoWriteOption</B>()</PRE>
<DL>
-<DD>Returns the write option associated with this object. - <p> - A write option is a lock that - <li>is exclusive; i.e. can only be held by one view</li> - <li>prevents other views from obtaining a write lock on the same object</li> - <li>does not prevent other views from obtaining a read lock on the same object</li> - <p> - It thus allows a view to ensure that it is the only that who will be able to obtain a write lock in the future, +<DD>Returns the write option associated with this object.
+ <p>
+ A write option is a lock that
+ <li>is exclusive; i.e. can only be held by one view</li>
+ <li>prevents other views from obtaining a write lock on the same object</li>
+ <li>does not prevent other views from obtaining a read lock on the same object</li>
+ <p>
+ It thus allows a view to ensure that it is the only that who will be able to obtain a write lock in the future,
without preventing read locks to be obtained by others at this moment.
<P>
<DD><DL>
@@ -527,8 +527,8 @@ cdoPrefetch</H3> <PRE>
void <B>cdoPrefetch</B>(int depth)</PRE>
<DL>
-<DD>Ensures that the revisions of the contained objects up to the given depth are in the local - <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevisionManager.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision cache</CODE></A>. Subsequent access to the respective contained objects will not lead to +<DD>Ensures that the revisions of the contained objects up to the given depth are in the local
+ <A HREF="../../../../org/eclipse/emf/cdo/common/revision/CDORevisionManager.html" title="interface in org.eclipse.emf.cdo.common.revision"><CODE>revision cache</CODE></A>. Subsequent access to the respective contained objects will not lead to
server round-trips after calling this method.
<P>
<DD><DL>
|