21 files changed, 85 insertions, 1 deletions
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDODefaultTransactionHandler3.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDODefaultTransactionHandler3.java
index 917ecbb70f..91e19a586f 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDODefaultTransactionHandler3.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/transaction/CDODefaultTransactionHandler3.java
@@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.transaction;
 import org.eclipse.emf.cdo.common.commit.CDOCommitInfo;
 
 /**
+ * An empty default implementation of {@link CDOTransactionHandler3}.
+ * 
  * @author Eike Stepper
  * @since 4.1
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOFactory.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOFactory.java
index 5653f1613b..0b376efeee 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOFactory.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOFactory.java
@@ -10,9 +10,13 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.CDOObject;
+
 import org.eclipse.emf.ecore.EFactory;
 
 /**
+ * Creates CDO {@link CDOObject objects}.
+ * 
  * @author Eike Stepper
  */
 public interface CDOFactory extends EFactory
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOLazyContentAdapter.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOLazyContentAdapter.java
index fca502dcbf..ea23552c06 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOLazyContentAdapter.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOLazyContentAdapter.java
@@ -28,6 +28,9 @@ import java.util.HashSet;
 import java.util.Set;
 
 /**
+ * A scalable {@link EContentAdapter content adapter} that uses CDO mechansims to attach itself to {@link CDOObject
+ * objects} when they are lazily loaded.
+ * 
  * @author Victor Roldan Betancort
  * @since 4.0
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOModificationTrackingAdapter.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOModificationTrackingAdapter.java
index 7768166fe2..77156a8c63 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOModificationTrackingAdapter.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOModificationTrackingAdapter.java
@@ -15,12 +15,16 @@ import org.eclipse.emf.cdo.eresource.EresourcePackage;
 import org.eclipse.emf.cdo.transaction.CDOCommitContext;
 import org.eclipse.emf.cdo.transaction.CDODefaultTransactionHandler;
 import org.eclipse.emf.cdo.transaction.CDOTransaction;
+import org.eclipse.emf.cdo.transaction.CDOTransactionHandler;
 
 import org.eclipse.emf.common.notify.Notification;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.emf.spi.cdo.InternalCDOView;
 
 /**
+ * Maintains the {@link Resource#isModified() modified state} of a CDO {@link CDOResource resource} with the help of a
+ * {@link CDOTransactionHandler transaction handler}.
+ * 
  * @author Victor Roldan Betancort
  * @since 4.0
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIData.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIData.java
index 6f079ceee0..ae21fbf13e 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIData.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIData.java
@@ -21,6 +21,8 @@ import org.eclipse.core.runtime.Path;
 import java.util.Map;
 
 /**
+ * Represents the CDO-specific URI data needed to access a resource in a repository.
+ * 
  * @author Eike Stepper
  * @since 4.0
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIUtil.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIUtil.java
index 32b60ebf03..9e04860435 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIUtil.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOURIUtil.java
@@ -28,6 +28,8 @@ import java.util.Map;
 import java.util.StringTokenizer;
 
 /**
+ * Various static methods that may help with CDO-specific {@link URI URIs}.
+ * 
  * @author Simon McDuff
  * @since 2.0
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUpdatable.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUpdatable.java
index 2dda87fa99..5845234cde 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUpdatable.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUpdatable.java
@@ -13,6 +13,9 @@ package org.eclipse.emf.cdo.util;
 import org.eclipse.emf.cdo.session.CDOSession.Options;
 
 /**
+ * Represents facilities that can receive
+ * {@link org.eclipse.emf.cdo.session.CDOSession.Options#setPassiveUpdateEnabled(boolean) passive updates}.
+ * 
  * @author Eike Stepper
  * @since 3.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUtil.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUtil.java
index c0cf2f312f..495ed65fb9 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUtil.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CDOUtil.java
@@ -62,6 +62,8 @@ import java.util.Iterator;
 import java.util.Map;
 
 /**
+ * Various static methods that may help in CDO client applications.
+ * 
  * @author Eike Stepper
  */
 public final class CDOUtil
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitException.java
index 29579f36cb..ffc8b2a959 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitException.java
@@ -10,7 +10,12 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.transaction.CDOTransaction;
+
 /**
+ * A checked exception being thrown from {@link CDOTransaction#commit()} in case of unrecoverable commit problems such
+ * as commit conflicts.
+ * 
  * @author Eike Stepper
  * @since 3.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitIntegrityException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitIntegrityException.java
index 3a1c282549..5b35eb108e 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitIntegrityException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/CommitIntegrityException.java
@@ -10,11 +10,16 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.transaction.CDOTransaction;
+
 import org.eclipse.emf.ecore.EObject;
 
 import java.util.Set;
 
 /**
+ * A {@link CommitException commit exception} that indicates referential integrity problems with
+ * {@link CDOTransaction#setCommittables(Set) partial commits} before the server is contacted.
+ * 
  * @author Caspar De Groot
  * @since 4.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/DanglingReferenceException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/DanglingReferenceException.java
index a77c6784ea..08177a3607 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/DanglingReferenceException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/DanglingReferenceException.java
@@ -11,15 +11,22 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.common.commit.CDOCommitData;
 import org.eclipse.emf.cdo.common.util.CDOException;
+import org.eclipse.emf.cdo.transaction.CDOTransaction;
 
 import org.eclipse.emf.internal.cdo.messages.Messages;
 
 import org.eclipse.emf.ecore.EObject;
+import org.eclipse.emf.ecore.resource.Resource;
 
 import java.text.MessageFormat;
 
 /**
+ * An unchecked exception being thrown from {@link CDOTransaction#commit()} if the commit {@link CDOCommitData change
+ * set} is referencing {@link EObject objects} that are not contained by any {@link Resource resource} before the server
+ * is contacted.
+ * 
  * @author Simon McDuff
  * @since 2.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/InvalidURIException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/InvalidURIException.java
index e4ec6345c2..d6543480c9 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/InvalidURIException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/InvalidURIException.java
@@ -11,6 +11,7 @@
 package org.eclipse.emf.cdo.util;
 
 import org.eclipse.emf.cdo.common.util.CDOException;
+import org.eclipse.emf.cdo.eresource.CDOResource;
 
 import org.eclipse.emf.internal.cdo.messages.Messages;
 
@@ -19,6 +20,8 @@ import org.eclipse.emf.common.util.URI;
 import java.text.MessageFormat;
 
 /**
+ * An unchecked exception being thrown to indicate problems with the {@link URI} of a {@link CDOResource resource}.
+ * 
  * @author Eike Stepper
  * @since 2.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LegacyModeNotEnabledException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LegacyModeNotEnabledException.java
index 7fb43ea068..dad41bccb0 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LegacyModeNotEnabledException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LegacyModeNotEnabledException.java
@@ -10,7 +10,13 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.view.CDOView;
+
 /**
+ * An unchecked exception being thrown if <i><a href="http://wiki.eclipse.org/CDO_Legacy_Mode">legacy objects</a></i>
+ * are to be accessed and the associated {@link CDOView view} is not in {@link CDOView#isLegacyModeEnabled() legacy
+ * mode}.
+ * 
  * @author Eike Stepper
  * @since 3.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LockTimeoutException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LockTimeoutException.java
index 4c28b2b1d0..aa5b42e70a 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LockTimeoutException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/LockTimeoutException.java
@@ -10,9 +10,15 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.CDOLock;
 import org.eclipse.emf.cdo.common.util.CDOException;
+import org.eclipse.emf.cdo.view.CDOView;
 
 /**
+ * An unchecked exception being thrown if {@link CDOLock locks} could not be
+ * {@link CDOView#lockObjects(java.util.Collection, org.eclipse.net4j.util.concurrent.IRWLockManager.LockType, long)
+ * acquired} within the specified timeout period.
+ * 
  * @author Caspar De Groot
  * @since 4.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReadOnlyException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReadOnlyException.java
index ed257ab649..77b4b6e82d 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReadOnlyException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReadOnlyException.java
@@ -10,9 +10,14 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.CDOObject;
 import org.eclipse.emf.cdo.common.util.CDOException;
+import org.eclipse.emf.cdo.view.CDOView;
 
 /**
+ * An unchecked exception being thrown if write access to {@link CDOObject objects} of a {@link CDOView#isReadOnly()
+ * read-only} view is attempted.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noinstantiate This class is not intended to be instantiated by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReferentialIntegrityException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReferentialIntegrityException.java
index c26a59f872..272a7182f2 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReferentialIntegrityException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ReferentialIntegrityException.java
@@ -15,6 +15,8 @@ import org.eclipse.emf.cdo.CDOObjectReference;
 import java.util.List;
 
 /**
+ * A {@link CommitException commit exception} that indicates referential integrity problems detected by the server.
+ * 
  * @author Eike Stepper
  * @since 4.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ServerException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ServerException.java
index f635473bed..98e71e9ba7 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ServerException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/ServerException.java
@@ -13,10 +13,14 @@ package org.eclipse.emf.cdo.util;
 import org.eclipse.emf.cdo.common.util.CDOException;
 
 /**
+ * An unchecked exception that indicates server-side problems.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noinstantiate This class is not intended to be instantiated by clients.
+ * @deprecated Not used.
  */
+@Deprecated
 public class ServerException extends CDOException
 {
   private static final long serialVersionUID = 1L;
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/StaleRevisionLockException.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/StaleRevisionLockException.java
index 4cce001cff..141d91667f 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/StaleRevisionLockException.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/util/StaleRevisionLockException.java
@@ -10,12 +10,23 @@
  */
 package org.eclipse.emf.cdo.util;
 
+import org.eclipse.emf.cdo.CDOObject;
+import org.eclipse.emf.cdo.common.branch.CDOBranch;
+import org.eclipse.emf.cdo.common.revision.CDORevision;
 import org.eclipse.emf.cdo.common.revision.CDORevisionKey;
 import org.eclipse.emf.cdo.common.util.CDOException;
+import org.eclipse.emf.cdo.view.CDOView;
 
 import org.eclipse.net4j.util.CheckUtil;
 
 /**
+ * An unchecked exception being thrown when attempting to
+ * {@link CDOView#lockObjects(java.util.Collection, org.eclipse.net4j.util.concurrent.IRWLockManager.LockType, long)
+ * lock} <i>stale</i> objects.
+ * <p>
+ * An {@link CDOObject object} is considered stale if its {@link CDORevision revision} is older than the latest server
+ * revision in the same {@link CDOBranch branch}.
+ * 
  * @author Caspar De Groot
  * @since 4.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
index a0cc14a4a5..9fc743942b 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOView.java
@@ -29,6 +29,7 @@ import org.eclipse.emf.cdo.eresource.CDOResourceNode;
 import org.eclipse.emf.cdo.session.CDOSession;
 import org.eclipse.emf.cdo.transaction.CDOTransaction;
 import org.eclipse.emf.cdo.util.CDOUpdatable;
+import org.eclipse.emf.cdo.util.CDOUtil;
 import org.eclipse.emf.cdo.util.ReadOnlyException;
 
 import org.eclipse.net4j.util.collection.CloseableIterator;
@@ -153,6 +154,7 @@ public interface CDOView extends CDOCommonView, CDOUpdatable, INotifier
   public boolean isInvalidationRunnerActive();
 
   /**
+   * @see CDOUtil#setLegacyModeDefault(boolean)
    * @since 3.0
    */
   public boolean isLegacyModeEnabled();
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewLocksChangedEvent.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewLocksChangedEvent.java
index 1a277873b1..84e08400e4 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewLocksChangedEvent.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewLocksChangedEvent.java
@@ -11,8 +11,14 @@
 package org.eclipse.emf.cdo.view;
 
 import org.eclipse.emf.cdo.common.lock.CDOLockChangeInfo;
+import org.eclipse.emf.cdo.session.CDOSession.Options;
 
 /**
+ * A {@link CDOViewEvent view event} fired when {@link CDOLockChangeInfo lock changes} are being received from a remote
+ * repository.
+ * {@link Options#setLockNotificationMode(org.eclipse.emf.cdo.common.CDOCommonSession.Options.LockNotificationMode) Lock
+ * notifications} must be enabled for this event to be fired.
+ * 
  * @author Caspar De Groot
  * @since 4.1
  */
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewProvider.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewProvider.java
index 6b64827153..ad5007915e 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewProvider.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/view/CDOViewProvider.java
@@ -16,7 +16,7 @@ import org.eclipse.emf.ecore.resource.ResourceSet;
 
 /**
  * Capable of opening a <code>CDOView</code> on a target repository, defined by a URI. A regular expression and the
- * priority are used to determine which is the most suitable provider
+ * priority are used to determine the most suitable provider.
  * 
  * @since 2.0
  * @author Victor Roldan Betancort