diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common')
68 files changed, 226 insertions, 5 deletions
diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonRepository.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonRepository.java index 93d1af0fe4..d509b32431 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonRepository.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonRepository.java @@ -18,6 +18,8 @@ import org.eclipse.net4j.util.event.IEvent; import java.util.Set; /** + * Abstracts the information about CDO repositories that is common to both client and server side. + * * @author Eike Stepper * @since 3.0 * @noextend This interface is not intended to be extended by clients. @@ -90,6 +92,8 @@ public interface CDOCommonRepository extends CDOTimeProvider public boolean isEnsuringReferentialIntegrity(); /** + * Enumerates the possible {@link CDOCommonRepository#getType() types} of a CDO repository. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. */ @@ -99,6 +103,8 @@ public interface CDOCommonRepository extends CDOTimeProvider } /** + * Enumerates the possible {@link CDOCommonRepository#getState() states} of a CDO repository. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. */ @@ -113,6 +119,9 @@ public interface CDOCommonRepository extends CDOTimeProvider } /** + * An {@link IEvent event} fired when the {@link Type type} of a CDO repository has changed. This usually happens only + * for repository fail-over participants. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. @@ -125,6 +134,8 @@ public interface CDOCommonRepository extends CDOTimeProvider } /** + * An {@link IEvent event} fired when the {@link State state} of a CDO repository has changed. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonSession.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonSession.java index a194d8cd21..533044166a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonSession.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonSession.java @@ -17,6 +17,8 @@ import org.eclipse.net4j.util.options.IOptionsEvent; import org.eclipse.net4j.util.security.IUserAware; /** + * Abstracts the information about CDO sessions that is common to both client and server side. + * * @author Eike Stepper * @since 2.0 * @noextend This interface is not intended to be extended by clients. @@ -36,12 +38,21 @@ public interface CDOCommonSession extends IUserAware, IOptionsContainer, Closeab public Options options(); /** + * Encapsulates the configuration options of CDO sessions that are common to both client and server side. + * * @author Simon McDuff * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. */ public interface Options extends IOptions { + /** + * Returns the {@link CDOCommonSession session} of this options object. + * + * @since 4.0 + */ + public CDOCommonSession getContainer(); + public boolean isPassiveUpdateEnabled(); /** @@ -74,6 +85,9 @@ public interface CDOCommonSession extends IUserAware, IOptionsContainer, Closeab public void setPassiveUpdateMode(PassiveUpdateMode mode); /** + * Enumerates the possible {@link CDOCommonSession.Options#getPassiveUpdateMode() passive update modes} of a CDO + * session. + * * @author Eike Stepper * @since 3.0 */ @@ -98,6 +112,9 @@ public interface CDOCommonSession extends IUserAware, IOptionsContainer, Closeab } /** + * An {@link IOptionsEvent options event} fired when the {@link PassiveUpdateMode passive update mode} of a CDO + * session has changed. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonTransaction.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonTransaction.java index 881f2df55d..75f4dba434 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonTransaction.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonTransaction.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common; /** + * Abstracts the information about CDO transactions that is common to both client and server side. + * * @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.common/src/org/eclipse/emf/cdo/common/CDOCommonView.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonView.java index 35f5559d62..f58ac44ccf 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonView.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/CDOCommonView.java @@ -16,6 +16,8 @@ import org.eclipse.emf.cdo.common.revision.CDORevisionProvider; import org.eclipse.net4j.util.collection.Closeable; /** + * Abstracts the information about CDO views that is common to both client and server side. + * * @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.common/src/org/eclipse/emf/cdo/common/branch/CDOBranch.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranch.java index 400ecbfc70..b88ee511a3 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranch.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranch.java @@ -30,6 +30,8 @@ import org.eclipse.net4j.util.container.IContainer; * * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranch extends IContainer<CDOBranch>, Comparable<CDOBranch> { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchCreatedEvent.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchCreatedEvent.java index 8c956c2d6b..75fc002ee8 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchCreatedEvent.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchCreatedEvent.java @@ -13,6 +13,9 @@ package org.eclipse.emf.cdo.common.branch; import org.eclipse.net4j.util.event.IEvent; /** + * An {@link IEvent event} fired from a {@link CDOBranchManager branch manager} when a new {@link CDOBranch branch} has + * been created. + * * @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.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchManager.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchManager.java index 07fe217252..70cf73b2dd 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchManager.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchManager.java @@ -35,6 +35,8 @@ import org.eclipse.net4j.util.event.INotifier; * * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranchManager extends INotifier { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPoint.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPoint.java index 54d42440c8..7b34a24000 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPoint.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPoint.java @@ -24,6 +24,8 @@ import org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil; * @see CDOBranchUtil#copyBranchPoint(CDOBranchPoint) * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranchPoint { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPointRange.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPointRange.java index 59dd482bf7..0c8d2d803c 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPointRange.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchPointRange.java @@ -25,6 +25,8 @@ import org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil; * * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranchPointRange { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchTag.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchTag.java index 6863f221e3..bca199851b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchTag.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchTag.java @@ -15,6 +15,8 @@ package org.eclipse.emf.cdo.common.branch; * * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranchTag extends CDOBranchPoint { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchVersion.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchVersion.java index e60fa8a1f5..aa40cd2cee 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchVersion.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/branch/CDOBranchVersion.java @@ -24,6 +24,8 @@ import org.eclipse.emf.cdo.common.revision.CDORevisionManager; * @see CDOBranch#getVersion(int) * @author Eike Stepper * @since 3.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOBranchVersion { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKind.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKind.java index 9d38fdfbfb..a0e028e0ff 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKind.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKind.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common.commit; /** + * Enumerates possible change kinds. + * * @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.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKindProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKindProvider.java index 5d02915181..a2abab9a8f 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKindProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeKindProvider.java @@ -13,8 +13,12 @@ package org.eclipse.emf.cdo.common.commit; import org.eclipse.emf.cdo.common.id.CDOID; /** + * Generic provider for the kinds of changes that have been applied to objects. + * * @author Eike Stepper * @since 4.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOChangeKindProvider { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSet.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSet.java index d94d96e362..447f22e33e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSet.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSet.java @@ -14,6 +14,9 @@ import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; import org.eclipse.emf.cdo.common.branch.CDOBranchPointRange; /** + * The {@link CDOChangeSetData change set data} between two {@link CDOBranchPointRange branch points} with a common + * ancestor. + * * @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.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetData.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetData.java index 12cccb7398..c49728e6a9 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetData.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetData.java @@ -19,6 +19,9 @@ import org.eclipse.emf.cdo.common.revision.delta.CDORevisionDelta; import java.util.List; /** + * A {@link CDOChangeKindProvider change kind provider} with detailed information about {@link #getNewObjects() new}, + * {@link #getChangedObjects() changed} and {@link #getDetachedObjects() detached} objects. + * * @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.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetDataProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetDataProvider.java index c40d252124..b7c68017e7 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetDataProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOChangeSetDataProvider.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.commit; /** * @author Eike Stepper * @since 4.0 + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface CDOChangeSetDataProvider { diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitData.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitData.java index 7d412d8990..bce71a9971 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitData.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitData.java @@ -15,6 +15,9 @@ import org.eclipse.emf.cdo.common.model.CDOPackageUnit; import java.util.List; /** + * {@link CDOChangeSetData Change set data} with detailed information about new {@link #getNewPackageUnits() package + * units}. + * * @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.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfo.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfo.java index 0176480d61..0b6fa57d6f 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfo.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfo.java @@ -13,6 +13,9 @@ package org.eclipse.emf.cdo.common.commit; import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; /** + * {@link CDOCommitData Commit data} in the context of a {@link CDOCommitInfoManager commit info manager} with + * additional commit informations. + * * @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.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoHandler.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoHandler.java index d8bbb6823d..25432b9528 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoHandler.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoHandler.java @@ -11,6 +11,9 @@ package org.eclipse.emf.cdo.common.commit; /** + * A call-back interface that indicates the ability to <i>handle</i> {@link CDOCommitInfo commit infos} that are passed + * from other entities. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoManager.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoManager.java index dc90e0377b..6820077a41 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoManager.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/CDOCommitInfoManager.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.commit; import org.eclipse.emf.cdo.common.branch.CDOBranch; /** + * Loads, provides and possible manages {@link CDOCommitInfo commit info} objects. + * * @author Andre Dietisheim * @since 3.0 * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/AsyncCommitInfoHandler.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/AsyncCommitInfoHandler.java index 1f9d4474a0..0c41e715bf 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/AsyncCommitInfoHandler.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/AsyncCommitInfoHandler.java @@ -17,6 +17,9 @@ import org.eclipse.emf.cdo.internal.common.bundle.OM; import org.eclipse.net4j.util.concurrent.QueueWorker; /** + * A {@link CDOCommitInfoHandler commit info handler} that asynchronously delegates {@link CDOCommitInfo commit infos} + * to another handler. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/BinaryCommitInfoLog.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/BinaryCommitInfoLog.java index b4a10dead7..f83f76b8a4 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/BinaryCommitInfoLog.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/BinaryCommitInfoLog.java @@ -24,6 +24,9 @@ import org.eclipse.net4j.util.io.ExtendedDataOutputStream; import java.io.OutputStream; /** + * A {@link CDOCommitInfoHandler commit info handler} that synchronously writes {@link CDOCommitInfo commit infos} to a + * binary log. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/TextCommitInfoLog.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/TextCommitInfoLog.java index 9253ea6f95..af4a96401a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/TextCommitInfoLog.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/commit/handler/TextCommitInfoLog.java @@ -20,6 +20,9 @@ import java.io.OutputStream; import java.io.PrintStream; /** + * A {@link CDOCommitInfoHandler commit info handler} that synchronously writes {@link CDOCommitInfo commit infos} to a + * text log. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOID.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOID.java index 6a15259f15..3e02bde70e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOID.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOID.java @@ -12,12 +12,16 @@ */ package org.eclipse.emf.cdo.common.id; +import org.eclipse.emf.cdo.common.CDOCommonRepository; + import org.eclipse.net4j.util.ImplementationError; import java.io.Serializable; import java.lang.reflect.Array; /** + * Identifies CDO objects uniquely in a CDO {@link CDOCommonRepository repository}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. @@ -50,6 +54,8 @@ public interface CDOID extends Serializable, Comparable<CDOID> public String toURIFragment(); /** + * Enumerates the possible types of CDO {@link CDOID IDs}. + * * @author Eike Stepper */ public enum Type @@ -122,6 +128,8 @@ public interface CDOID extends Serializable, Comparable<CDOID> } /** + * Enumerates the possible <b>sub</b> types of CDO {@link CDOID IDs} with the main type {@link Type#OBJECT OBJECT}. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDExternal.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDExternal.java index 9a2f80e5cf..457826d110 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDExternal.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDExternal.java @@ -11,7 +11,11 @@ */ package org.eclipse.emf.cdo.common.id; +import org.eclipse.emf.cdo.common.CDOCommonRepository; + /** + * The {@link CDOID ID} of a CDO object that is external to a CDO {@link CDOCommonRepository repository}. + * * @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.common/src/org/eclipse/emf/cdo/common/id/CDOIDObject.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDObject.java index e9d908fba8..529cad767f 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDObject.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDObject.java @@ -10,7 +10,11 @@ */ package org.eclipse.emf.cdo.common.id; +import org.eclipse.emf.cdo.common.CDOCommonRepository; + /** + * The {@link CDOID ID} of a CDO object that is persistent in a CDO {@link CDOCommonRepository repository}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDProvider.java index 5e25af0727..d2fae2cd02 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDProvider.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common.id; /** + * Provides the {@link CDOID IDs} of passed objects. + * * @author Eike Stepper */ public interface CDOIDProvider diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDReference.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDReference.java index 93c468968a..ae2dd4448e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDReference.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDReference.java @@ -19,6 +19,8 @@ import org.eclipse.emf.ecore.EStructuralFeature; import java.io.IOException; /** + * Represents a {@link CDOID} typed reference from one object to another object. + * * @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.common/src/org/eclipse/emf/cdo/common/id/CDOIDTemp.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDTemp.java index f6b0aa9754..05ed7db8f8 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDTemp.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDTemp.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.id; +import org.eclipse.emf.cdo.common.CDOCommonTransaction; + /** + * The {@link CDOID ID} of a CDO object that is new in a dirty (uncommitted) CDO {@link CDOCommonTransaction + * transaction}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDUtil.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDUtil.java index 77b4f2beb4..0f290e4a0c 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDUtil.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOIDUtil.java @@ -40,6 +40,8 @@ import org.eclipse.net4j.util.ObjectUtil; import java.text.MessageFormat; /** + * Various static methods that may help with CDO {@link CDOID IDs}. + * * @author Eike Stepper * @since 2.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOReference.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOReference.java index bb83163947..3608f7c9ad 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOReference.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOReference.java @@ -17,6 +17,8 @@ import org.eclipse.emf.ecore.EStructuralFeature; import org.eclipse.emf.ecore.util.FeatureMap; /** + * Represents a reference from one object to another object, possibly {@link CDOID} or CDOObject typed. + * * @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.common/src/org/eclipse/emf/cdo/common/id/CDOWithID.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOWithID.java index a2b0156fe0..e792a5d207 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOWithID.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/id/CDOWithID.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common.id;
/**
+ * An identifiable object.
+ *
* @author Eike Stepper
* @since 4.0
*/
diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOBlob.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOBlob.java index e748da3ec1..7d8a94a886 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOBlob.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOBlob.java @@ -18,6 +18,8 @@ import java.io.IOException; import java.io.InputStream; /** + * A identifiable binary large object with streaming support. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOClob.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOClob.java index 50c0568d5a..dd11b3cb4b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOClob.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOClob.java @@ -18,6 +18,8 @@ import java.io.IOException; import java.io.Reader; /** + * A identifiable character large object with streaming support. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLob.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLob.java index f6df241e0c..d5558433b6 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLob.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLob.java @@ -16,6 +16,8 @@ import org.eclipse.net4j.util.io.ExtendedDataOutput; import java.io.IOException; /** + * A identifiable large object with streaming support. + * * @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.common/src/org/eclipse/emf/cdo/common/lob/CDOLobInfo.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobInfo.java index 6f881771c8..a823826abb 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobInfo.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobInfo.java @@ -15,6 +15,8 @@ import org.eclipse.net4j.util.HexUtil; import java.text.MessageFormat; /** + * Encapsulates {@link #getID() ID} and {@link #getSize() size} of a {@link CDOLob large object}. + * * @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.common/src/org/eclipse/emf/cdo/common/lob/CDOLobStore.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobStore.java index cfe6e42af3..29142800a2 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobStore.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobStore.java @@ -16,6 +16,8 @@ import java.io.InputStream; import java.io.Reader; /** + * Stores and loads {@link CDOLob large objects}. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobUtil.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobUtil.java index e2e550cf2c..9fdb999b04 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobUtil.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lob/CDOLobUtil.java @@ -16,6 +16,8 @@ import org.eclipse.net4j.util.io.ExtendedDataOutput; import java.io.IOException; /** + * Some useful helpers for dealing with {@link CDOLob large objects}. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lock/IDurableLockingManager.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lock/IDurableLockingManager.java index 52f803bbc2..474435797f 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lock/IDurableLockingManager.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/lock/IDurableLockingManager.java @@ -10,6 +10,7 @@ */
package org.eclipse.emf.cdo.common.lock;
+import org.eclipse.emf.cdo.common.CDOCommonRepository;
import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
import org.eclipse.emf.cdo.common.id.CDOID;
@@ -18,6 +19,9 @@ import org.eclipse.net4j.util.concurrent.IRWLockManager.LockType; import java.util.Map;
/**
+ * Manages all aspects of durable CDO views like persisting informations like {@link CDOBranchPoint branch point} and
+ * acquired locks.
+ *
* @author Eike Stepper
* @since 4.0
* @noextend This interface is not intended to be extended by clients.
@@ -41,6 +45,9 @@ public interface IDurableLockingManager public void deleteLockArea(String durableLockingID);
/**
+ * Encapsulates the persistable information about a single durable CDO view like {@link CDOBranchPoint branch point}
+ * and acquired locks.
+ *
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
@@ -56,6 +63,8 @@ public interface IDurableLockingManager public Map<CDOID, LockGrade> getLocks();
/**
+ * A call-back interface for <em>handling</em> {@link LockArea lock area} objects.
+ *
* @author Eike Stepper
*/
public interface Handler
@@ -65,6 +74,9 @@ public interface IDurableLockingManager }
/**
+ * Thrown if a {@link LockArea lock area} is spcified that does not exist in a CDO {@link CDOCommonRepository
+ * repository}.
+ *
* @author Eike Stepper
*/
public static class LockAreaNotFoundException extends IllegalStateException
@@ -92,6 +104,8 @@ public interface IDurableLockingManager }
/**
+ * Enumerates the possible combinations of read and write locks on a single CDO object.
+ *
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
*/
diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassInfo.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassInfo.java index 3432771743..ef979d6e5e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassInfo.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassInfo.java @@ -15,6 +15,8 @@ import org.eclipse.emf.ecore.EClass; import org.eclipse.emf.ecore.EStructuralFeature; /** + * An EMF {@link Adapter adapter} that encapsulates CDO specific information about an {@link EClass}. + * * @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.common/src/org/eclipse/emf/cdo/common/model/CDOClassifierRef.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassifierRef.java index 35e8efd364..c2e3fdd6dd 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassifierRef.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOClassifierRef.java @@ -23,6 +23,8 @@ import java.io.IOException; import java.text.MessageFormat; /** + * References an {@link EClassifier}. + * * @author Eike Stepper * @since 2.0 */ @@ -144,6 +146,8 @@ public final class CDOClassifierRef } /** + * Provides {@link CDOClassifierRef classifier references}. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelConstants.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelConstants.java index 725250bc2f..5ad8f6e8cf 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelConstants.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelConstants.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common.model; /** + * Symbolic model constants commonly used in CDO. + * * @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.common/src/org/eclipse/emf/cdo/common/model/CDOModelUtil.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelUtil.java index 99ba8e0745..6ecc395a9b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelUtil.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOModelUtil.java @@ -143,7 +143,8 @@ public final class CDOModelUtil implements CDOModelConstants */ public static boolean isResourceFolder(EClass eClass) { - return isResourcePackage(eClass.getEPackage()) && CDOModelConstants.RESOURCE_FOLDER_CLASS_NAME.equals(eClass.getName()); + return isResourcePackage(eClass.getEPackage()) + && CDOModelConstants.RESOURCE_FOLDER_CLASS_NAME.equals(eClass.getName()); } /** @@ -152,8 +153,9 @@ public final class CDOModelUtil implements CDOModelConstants public static boolean isResourceNode(EClass eClass) { return isResourcePackage(eClass.getEPackage()) - && (CDOModelConstants.RESOURCE_NODE_CLASS_NAME.equals(eClass.getName()) || CDOModelConstants.RESOURCE_CLASS_NAME.equals(eClass.getName()) || CDOModelConstants.RESOURCE_FOLDER_CLASS_NAME - .equals(eClass.getName())); + && (CDOModelConstants.RESOURCE_NODE_CLASS_NAME.equals(eClass.getName()) + || CDOModelConstants.RESOURCE_CLASS_NAME.equals(eClass.getName()) || CDOModelConstants.RESOURCE_FOLDER_CLASS_NAME + .equals(eClass.getName())); } /** @@ -178,7 +180,8 @@ public final class CDOModelUtil implements CDOModelConstants public static boolean isLob(EClassifier eClassifier) { return isTypesPackage(eClassifier.getEPackage()) - && (CDOModelConstants.BLOB_CLASS_NAME.equals(eClassifier.getName()) || CDOModelConstants.CLOB_CLASS_NAME.equals(eClassifier.getName())); + && (CDOModelConstants.BLOB_CLASS_NAME.equals(eClassifier.getName()) || CDOModelConstants.CLOB_CLASS_NAME + .equals(eClassifier.getName())); } /** diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistry.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistry.java index 3cd8292243..e67d53b2d0 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistry.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistry.java @@ -11,15 +11,22 @@ */ package org.eclipse.emf.cdo.common.model; +import org.eclipse.emf.cdo.common.CDOCommonRepository; +import org.eclipse.emf.cdo.common.CDOCommonSession; + import org.eclipse.emf.common.util.Enumerator; import org.eclipse.emf.ecore.EClass; import org.eclipse.emf.ecore.EEnumLiteral; import org.eclipse.emf.ecore.EPackage; +import org.eclipse.emf.ecore.EPackage.Registry; import java.util.List; import java.util.Map; /** + * An EMF {@link Registry package registry} that is used by CDO {@link CDOCommonRepository repositories} and + * {@link CDOCommonSession sessions}. + * * @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.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistryPopulator.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistryPopulator.java index e1be00f9bc..78abe38b63 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistryPopulator.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageRegistryPopulator.java @@ -18,6 +18,9 @@ import org.eclipse.emf.ecore.EPackage; import java.util.Map.Entry; /** + * Populates a {@link #getTarget() target} package registry by asynchronously polling a {@link #getSource() source} + * package registry for new {@link EPackage} registrations. + * * @author Eike Stepper * @since 2.0 */ @@ -113,6 +116,9 @@ public class CDOPackageRegistryPopulator extends Worker } /** + * A package {@link org.eclipse.emf.ecore.EPackage.Descriptor descriptor} that resolves {@link EPackage packages} from + * a {@link #getSource() source } package registry. + * * @author Eike Stepper */ public static class Descriptor implements EPackage.Descriptor diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageTypeRegistry.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageTypeRegistry.java index 332fcbf43c..10dbaaee43 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageTypeRegistry.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/CDOPackageTypeRegistry.java @@ -10,6 +10,8 @@ */ package org.eclipse.emf.cdo.common.model; +import org.eclipse.emf.cdo.common.model.CDOPackageUnit.Type; + import org.eclipse.net4j.util.ObjectUtil; import org.eclipse.net4j.util.om.OMPlatform; @@ -25,6 +27,8 @@ import java.util.HashMap; import java.util.Map; /** + * A {@link #INSTANCE singleton} registry for the {@link Type package unit types} of EMF {@link EPackage packages}. + * * @author Eike Stepper * @since 2.0 */ @@ -209,7 +213,7 @@ public final class CDOPackageTypeRegistry } /** - * TODO Remove me when client and common are unified! + * A common marker interface for CDO (native) objects. * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/EMFUtil.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/EMFUtil.java index fef294c7bb..b948c14aac 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/EMFUtil.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/model/EMFUtil.java @@ -52,6 +52,8 @@ import java.util.Map.Entry; import java.util.Set; /** + * Various static helper methods for dealing with EMF meta models. + * * @author Eike Stepper * @since 2.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataInput.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataInput.java index 3cc44eeb35..2cbbde9d83 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataInput.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataInput.java @@ -43,6 +43,8 @@ import org.eclipse.emf.ecore.resource.ResourceSet; import java.io.IOException; /** + * Provides I/O methods for reading various CDO data types and concepts from streams. + * * @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.common/src/org/eclipse/emf/cdo/common/protocol/CDODataOutput.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataOutput.java index 33df1520c0..db036d7926 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataOutput.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDODataOutput.java @@ -44,6 +44,8 @@ import org.eclipse.emf.ecore.EStructuralFeature; import java.io.IOException; /** + * Provides I/O methods for writing various CDO data types and concepts to streams. + * * @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.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocol.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocol.java index 906dc6923d..16ca725714 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocol.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocol.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.protocol; import org.eclipse.emf.cdo.common.CDOCommonSession; /** + * The communications protocol associated with a CDO {@link CDOCommonSession session}. + * * @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.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocolConstants.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocolConstants.java index 2bf59c9173..ef2fbfee26 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocolConstants.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/protocol/CDOProtocolConstants.java @@ -14,6 +14,8 @@ package org.eclipse.emf.cdo.common.protocol; /** + * Symbolic protocol constants commonly used in CDO. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDOAllRevisionsProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOAllRevisionsProvider.java index 3a81b8aa6b..e00ca9da3d 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOAllRevisionsProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOAllRevisionsProvider.java @@ -16,6 +16,8 @@ import java.util.List; import java.util.Map; /** + * Provides consumers with all {@link CDORevision revisions} available in an instance of this interface. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOElementProxy.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOElementProxy.java index eef604a905..b14e1f20fb 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOElementProxy.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOElementProxy.java @@ -12,6 +12,8 @@ package org.eclipse.emf.cdo.common.revision; /** + * A moveable placeholder for the element of a {@link CDOList list} at a specified {@link #getIndex() index}. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndBranch.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndBranch.java index 3483ef952a..4522027223 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndBranch.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndBranch.java @@ -14,6 +14,8 @@ import org.eclipse.emf.cdo.common.branch.CDOBranch; import org.eclipse.emf.cdo.common.id.CDOID; /** + * An {@link CDOID ID} / {@link CDOBranch branch} pair. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndVersion.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndVersion.java index ab1a9f7d21..e8c9812c7d 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndVersion.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOIDAndVersion.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.revision; import org.eclipse.emf.cdo.common.id.CDOID; /** + * An {@link CDOID ID} / version pair. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDOList.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOList.java index 2303eb3ade..abffa46d1a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOList.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOList.java @@ -16,6 +16,8 @@ import org.eclipse.net4j.util.collection.MoveableList; import org.eclipse.emf.common.util.EList; /** + * A {@link MoveableList moveable} {@link EList}. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDOListFactory.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOListFactory.java index b5cc09ff16..03e93d5b0e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOListFactory.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDOListFactory.java @@ -14,6 +14,8 @@ package org.eclipse.emf.cdo.common.revision; import org.eclipse.emf.cdo.internal.common.revision.CDOListImpl; /** + * Creates {@link CDOList list} instances. + * * @author Simon McDuff * @since 2.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisable.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisable.java index 0547f68575..023bd37d30 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisable.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisable.java @@ -10,10 +10,13 @@ */
package org.eclipse.emf.cdo.common.revision;
+import org.eclipse.emf.cdo.common.branch.CDOBranch;
import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
import org.eclipse.emf.cdo.common.branch.CDOBranchVersion;
/**
+ * An entity that has a defined lifetime (creation plus revision) and a version in a {@link CDOBranch branch}.
+ *
* @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.common/src/org/eclipse/emf/cdo/common/revision/CDORevision.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevision.java index e130bcb29f..38695b07d6 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevision.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevision.java @@ -19,6 +19,8 @@ import org.eclipse.emf.cdo.common.revision.delta.CDORevisionDelta; import org.eclipse.emf.ecore.EClass; /** + * Encapsulates the immutable information of a single CDO object between two commits in a {@link CDOBranch branch}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCache.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCache.java index e8c2ef7b23..febdaca75b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCache.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCache.java @@ -23,6 +23,9 @@ import org.eclipse.emf.ecore.EClass; import java.util.List; /** + * Caches {@link CDORevision revisions} and possibly {@link EvictionEvent evicts} those that are no longer strongly + * referenced when free memory runs low. + * * @author Eike Stepper * @since 4.0 * @noextend This interface is not intended to be extended by clients. @@ -55,6 +58,9 @@ public interface CDORevisionCache extends CDORevisionCacheAdder, INotifier public List<CDORevision> getCurrentRevisions(); /** + * An {@link IEvent event} fired from a {@link CDORevisionCache revision cache} for {@link CDORevision revisions} that + * are evicted because they are no longer strongly referenced when free memory runs low. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCacheAdder.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCacheAdder.java index a22252ce86..bb3b913bca 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCacheAdder.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionCacheAdder.java @@ -11,6 +11,8 @@ package org.eclipse.emf.cdo.common.revision; /** + * An entity that {@link CDORevision revisions} can be added to. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionData.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionData.java index 39241602d5..373e0c6024 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionData.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionData.java @@ -16,6 +16,8 @@ import org.eclipse.emf.ecore.EStructuralFeature; import org.eclipse.emf.ecore.impl.EStoreEObjectImpl; /** + * Encapsulates the modeled information and the EMF system values of a {@link CDORevision revision}. + * * @author Eike Stepper * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionFactory.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionFactory.java index 153825451b..c55d8a48d3 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionFactory.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionFactory.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.revision; import org.eclipse.emf.ecore.EClass; /** + * Creates {@link CDORevision revision} instances. + * * @author Eike Stepper * @since 2.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionHandler.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionHandler.java index 7ea744c698..19efdb499c 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionHandler.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionHandler.java @@ -11,6 +11,9 @@ package org.eclipse.emf.cdo.common.revision; /** + * A call-back interface that indicates the ability to <i>handle</i> {@link CDORevision revisions} that are passed from + * other entities. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionKey.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionKey.java index 3cebc375d8..2a274a0ab5 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionKey.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionKey.java @@ -10,9 +10,12 @@ */ package org.eclipse.emf.cdo.common.revision; +import org.eclipse.emf.cdo.common.branch.CDOBranch; import org.eclipse.emf.cdo.common.branch.CDOBranchVersion; /** + * Uniquely identifies a {@link CDORevision revision} by version in a {@link CDOBranch branch}. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionManager.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionManager.java index 92b03b75eb..4540119641 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionManager.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionManager.java @@ -10,6 +10,7 @@ */ package org.eclipse.emf.cdo.common.revision; +import org.eclipse.emf.cdo.common.CDOCommonRepository; import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; import org.eclipse.emf.cdo.common.branch.CDOBranchVersion; import org.eclipse.emf.cdo.common.id.CDOID; @@ -19,6 +20,9 @@ import org.eclipse.emf.ecore.EClass; import java.util.List; /** + * Provides access to {@link CDORevision revisions} in a CDO {@link CDOCommonRepository repository} by demand loading + * and caching them. + * * @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.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionProvider.java index e42f3313e7..b6ff41852a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionProvider.java @@ -10,9 +10,13 @@ */ package org.eclipse.emf.cdo.common.revision; +import org.eclipse.emf.cdo.common.branch.CDOBranchPoint; import org.eclipse.emf.cdo.common.id.CDOID; /** + * Provides consumers with the {@link CDORevision revisions} of {@link CDOID identifiable} CDO objects by selecting a + * particular one from several possible {@link CDOBranchPoint branch points}. + * * @author Eike Stepper * @since 3.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionUtil.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionUtil.java index 3e38871bd2..0edfcad8d3 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionUtil.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/CDORevisionUtil.java @@ -52,6 +52,8 @@ import java.util.Set; import java.util.StringTokenizer; /** + * Various static helper methods for dealing with {@link CDORevision revisions}. + * * @author Eike Stepper */ public final class CDORevisionUtil |