diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision')
14 files changed, 70 insertions, 0 deletions
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 e51a317f83..8c75566193 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 @@ -30,6 +30,9 @@ public interface CDORevisionHandler public boolean handleRevision(CDORevision revision); /** + * A delegating {@link CDORevisionHandler revision handler} with a {@link #filter(CDORevision) filter()} method used + * to suppress specific revisions. + * * @author Eike Stepper * @since 4.1 */ @@ -58,6 +61,8 @@ public interface CDORevisionHandler } /** + * A delegating {@link Filtered revision handler} that filters detached revisions. + * * @author Eike Stepper */ public static final class Undetached extends Filtered 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 f62663af3a..0a2e484d58 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 @@ -354,6 +354,9 @@ public final class CDORevisionUtil } /** + * Dumps {@link CDORevision revisions}, sorted and grouped by {@link CDOBranch branch}, to various output formats and + * targets. Concrete output formats and targets are implemented by subclasses. + * * @since 4.0 */ public static abstract class AllRevisionsDumper @@ -405,6 +408,9 @@ public final class CDORevisionUtil protected abstract void dumpRevision(CDORevision revision); /** + * A {@link AllRevisionsDumper revision dumper} that directs all output to a stream. The concrete output format is + * implemented by subclasses. + * * @author Eike Stepper */ public static abstract class Stream extends AllRevisionsDumper @@ -423,6 +429,8 @@ public final class CDORevisionUtil } /** + * A {@link Stream revision dumper} that directs all output as plain text to a stream. + * * @author Eike Stepper */ public static class Plain extends Stream @@ -470,6 +478,8 @@ public final class CDORevisionUtil } /** + * A {@link Stream revision dumper} that directs all output as HTML text to a stream. + * * @author Eike Stepper */ public static class Html extends Stream @@ -537,6 +547,9 @@ public final class CDORevisionUtil } /** + * Compares {@link CDORevisionKey revision keys} by {@link CDORevision#getID() ID} and + * {@link CDORevision#getVersion() version}. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOAddFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOAddFeatureDelta.java index dadce8895a..60a9f0788a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOAddFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOAddFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents an addition to a many-valued {@link EStructuralFeature + * feature}. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOClearFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOClearFeatureDelta.java index 25bc6ea8bc..8c604eb9e7 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOClearFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOClearFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents the removal of all elements from a many-valued + * {@link EStructuralFeature feature}. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOContainerFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOContainerFeatureDelta.java index dd49ed27aa..1d03cf9558 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOContainerFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOContainerFeatureDelta.java @@ -14,9 +14,13 @@ package org.eclipse.emf.cdo.common.revision.delta; import org.eclipse.emf.cdo.common.id.CDOID; +import org.eclipse.emf.ecore.EObject; import org.eclipse.emf.ecore.EReference; /** + * A {@link CDOFeatureDelta feature delta} that represents a modification of the {@link EObject#eContainer() eContainer} + * feature. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDelta.java index af8de57e35..8ca32bc76a 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDelta.java @@ -17,6 +17,8 @@ import org.eclipse.emf.common.notify.Notification; import org.eclipse.emf.ecore.EStructuralFeature; /** + * Represents a change delta between two values of a single {@link EStructuralFeature feature}. + * * @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. @@ -62,6 +64,8 @@ public interface CDOFeatureDelta public boolean isStructurallyEqual(Object obj); /** + * Enumerates the possible types of {@link CDOFeatureDelta feature deltas}. + * * @author Simon McDuff */ public enum Type diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDeltaVisitor.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDeltaVisitor.java index d6047fa019..4583e86818 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDeltaVisitor.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOFeatureDeltaVisitor.java @@ -12,6 +12,9 @@ package org.eclipse.emf.cdo.common.revision.delta; /** + * Visits all {@link CDOFeatureDelta feature deltas} of a {@link CDORevisionDelta revision delta}. + * + * @see CDORevisionDelta#accept(CDOFeatureDeltaVisitor) * @author Simon McDuff */ public interface CDOFeatureDeltaVisitor diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOListFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOListFeatureDelta.java index d90569d753..8614c7e61b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOListFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOListFeatureDelta.java @@ -11,9 +11,15 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + import java.util.List; /** + * A {@link CDOFeatureDelta feature delta} that represents any modification of the list of a many-valued + * {@link EStructuralFeature feature}. The detailed changes to this list are returned by the {@link #getListChanges()} + * method. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOMoveFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOMoveFeatureDelta.java index 603cd05fdd..67e94e6dba 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOMoveFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOMoveFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents a move of one element of a many-valued + * {@link EStructuralFeature feature} to a different list position. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORemoveFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORemoveFeatureDelta.java index ceb004dba1..f48c4c6120 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORemoveFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORemoveFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents a removal from a many-valued {@link EStructuralFeature + * feature}. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDelta.java index f7ceaba4d9..9685b3f39f 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDelta.java @@ -25,6 +25,9 @@ import org.eclipse.emf.ecore.EStructuralFeature; import java.util.List; /** + * Represents the change delta between two {@link CDORevision revisions} of a CDO object. The detailed + * {@link CDOFeatureDelta feature deltas} are returned by the {@link #getFeatureDeltas()} method. + * * @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/delta/CDORevisionDeltaProvider.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDeltaProvider.java index 1e9d4235db..288b8df90d 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDeltaProvider.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDORevisionDeltaProvider.java @@ -13,6 +13,8 @@ package org.eclipse.emf.cdo.common.revision.delta; import org.eclipse.emf.cdo.common.id.CDOID; /** + * Provides consumers with the {@link CDORevisionDelta revision deltas} of {@link CDOID identifiable} CDO objects. + * * @author Eike Stepper * @since 4.0 */ diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOSetFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOSetFeatureDelta.java index 66cdd6f4a8..35cd31171e 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOSetFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOSetFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents a value change of a single-valued {@link EStructuralFeature + * feature}. + * * @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. diff --git a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOUnsetFeatureDelta.java b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOUnsetFeatureDelta.java index d91c6b998e..fc5ac3dc7b 100644 --- a/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOUnsetFeatureDelta.java +++ b/plugins/org.eclipse.emf.cdo.common/src/org/eclipse/emf/cdo/common/revision/delta/CDOUnsetFeatureDelta.java @@ -11,7 +11,12 @@ */ package org.eclipse.emf.cdo.common.revision.delta; +import org.eclipse.emf.ecore.EStructuralFeature; + /** + * A {@link CDOFeatureDelta feature delta} that represents the <em>unsetting</em> of the value of a + * {@link EStructuralFeature feature}. + * * @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. |