Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Roldan Betancort2011-12-14 15:36:17 +0000
committerVictor Roldan Betancort2011-12-14 15:36:17 +0000
commit4ee8331869298caadb06125cda1a3d16fa6e5102 (patch)
tree702e98e1172662c9a863e79bff5eb37489097f84 /plugins
parentfeb887d31db2e390d45e31852475943439da9db3 (diff)
downloadcdo-4ee8331869298caadb06125cda1a3d16fa6e5102.tar.gz
cdo-4ee8331869298caadb06125cda1a3d16fa6e5102.tar.xz
cdo-4ee8331869298caadb06125cda1a3d16fa6e5102.zip
added javadocs
Diffstat (limited to 'plugins')
-rw-r--r--plugins/org.eclipse.emf.cdo.defs/.settings/org.eclipse.core.resources.prefs2
-rw-r--r--plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/CommonNavigatorUtils.java12
-rw-r--r--plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/Node.java13
-rw-r--r--plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryContentProvider.java5
-rw-r--r--plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryLabelProvider.java3
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEditorInput.java19
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEventHandler.java5
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOInteractiveExceptionHandler.java7
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOItemProvider.java10
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOLabelProvider.java8
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/AuditScale.java3
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/ComposeBranchPointComposite.java4
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectBranchComposite.java3
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectTimeStampComposite.java3
-rw-r--r--plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SessionComposite.java4
-rw-r--r--plugins/org.eclipse.net4j.http.common/.settings/org.eclipse.core.resources.prefs2
16 files changed, 101 insertions, 2 deletions
diff --git a/plugins/org.eclipse.emf.cdo.defs/.settings/org.eclipse.core.resources.prefs b/plugins/org.eclipse.emf.cdo.defs/.settings/org.eclipse.core.resources.prefs
index 88761ebf4d..2e9d484e4d 100644
--- a/plugins/org.eclipse.emf.cdo.defs/.settings/org.eclipse.core.resources.prefs
+++ b/plugins/org.eclipse.emf.cdo.defs/.settings/org.eclipse.core.resources.prefs
@@ -1,3 +1,3 @@
-#Mon Jul 04 13:03:55 CEST 2011
+#Tue Dec 13 11:34:08 GMT 2011
eclipse.preferences.version=1
encoding//model/org.eclipse.emf.cdo.defs.ecorediag=UTF-8
diff --git a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/CommonNavigatorUtils.java b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/CommonNavigatorUtils.java
index 37293b0ce7..de9899bb1d 100644
--- a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/CommonNavigatorUtils.java
+++ b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/CommonNavigatorUtils.java
@@ -22,6 +22,8 @@ import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.PartInitException;
/**
+ * Miscellaneous functionality associated with visualization on the Common Navigator Framework.
+ *
* @author Victor Roldan Betancort
*/
public final class CommonNavigatorUtils
@@ -30,6 +32,10 @@ public final class CommonNavigatorUtils
{
}
+ /**
+ * Creates a fake {@link org.eclipse.core.runtime.IAdaptable adaptable} object whose sole purpose is to show a message
+ * in the common navigator.
+ */
public static Object createMessageProvider(final String message, final MessageType type)
{
return new IAdaptable()
@@ -97,6 +103,10 @@ public final class CommonNavigatorUtils
};
}
+ /**
+ * Same as {@link #createMessageProvider(String, MessageType)}, but returning the object as an <code>Object</code>
+ * array
+ */
public static Object[] createMessageProviderChild(final String message, final MessageType type)
{
Object[] result = { createMessageProvider(message, type) };
@@ -104,6 +114,8 @@ public final class CommonNavigatorUtils
}
/**
+ * Defines message decoration to be shown in the Common Navigator through {@link CommonNavigatorUtils}
+ *
* @author Victor Roldan Betancort
*/
public static enum MessageType
diff --git a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/Node.java b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/Node.java
index e3a140f390..8a27d46ffb 100644
--- a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/Node.java
+++ b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/Node.java
@@ -29,6 +29,8 @@ import java.util.ArrayList;
import java.util.List;
/**
+ * {@link org.eclipse.core.runtime.IAdaptable Adaptable} abstraction for an UI representation of basic CDO concepts.
+ *
* @author Eike Stepper
*/
public abstract class Node extends PlatformObject
@@ -64,6 +66,8 @@ public abstract class Node extends PlatformObject
public abstract Type getType();
/**
+ * Differentiates kinds of {@link org.eclipse.emf.cdo.ui.ide.Node nodes}
+ *
* @author Eike Stepper
*/
public static enum Type
@@ -72,6 +76,8 @@ public abstract class Node extends PlatformObject
}
/**
+ * Convenience UI object to represent a {@link org.eclipse.emf.cdo.common.branch.CDOBranch branch}
+ *
* @author Victor Roldan Betancort
*/
public static final class BranchNode extends Node
@@ -139,6 +145,9 @@ public abstract class Node extends PlatformObject
}
/**
+ * Convenience UI object to represent the {@link org.eclipse.emf.cdo.common.model.CDOPackageRegistry
+ * CDOPackageRegistry}
+ *
* @author Eike Stepper
*/
public static final class PackagesNode extends Node
@@ -190,6 +199,8 @@ public abstract class Node extends PlatformObject
}
/**
+ * Convenience UI object to represent the {@link org.eclipse.emf.cdo.eresource.CDOResourceNode CDOResourceNode}
+ *
* @author Eike Stepper
*/
public static final class ResourcesNode extends Node
@@ -247,6 +258,8 @@ public abstract class Node extends PlatformObject
}
/**
+ * Convenience UI object to represent the {@link org.eclipse.emf.cdo.session.CDOSession CDOSession}
+ *
* @author Eike Stepper
*/
public static final class SessionsNode extends Node
diff --git a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryContentProvider.java b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryContentProvider.java
index 6ff69956a2..905eef759a 100644
--- a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryContentProvider.java
+++ b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryContentProvider.java
@@ -74,6 +74,11 @@ import java.util.Map;
import java.util.Set;
/**
+ * {@link org.eclipse.jface.viewers.ITreeContentProvider ITreeContentProvider} implementation for the CDO Team
+ * integration. Capable of providing containment information for an {@link org.eclipse.core.resources.IProject project}
+ * synchronized with a repository. Understands containment information of the {@link org.eclipse.emf.cdo.ui.ide.Node
+ * node} abstraction.
+ *
* @author Eike Stepper
*/
public class RepositoryContentProvider extends StructuredContentProvider<IWorkspaceRoot> implements
diff --git a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryLabelProvider.java b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryLabelProvider.java
index b005c444bf..d48957b576 100644
--- a/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryLabelProvider.java
+++ b/plugins/org.eclipse.emf.cdo.ui.ide/src/org/eclipse/emf/cdo/ui/ide/RepositoryLabelProvider.java
@@ -25,6 +25,9 @@ import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.swt.graphics.Image;
/**
+ * {@link org.eclipse.jface.viewers.ILabelProvider ILabelProvider} implementation for the CDO Team integration. Capable
+ * of providing text and image information for {@link org.eclipse.emf.cdo.ui.ide.Node nodes}
+ *
* @author Eike Stepper
*/
public class RepositoryLabelProvider extends LabelProvider
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEditorInput.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEditorInput.java
index 3f71a76416..4e87367260 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEditorInput.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEditorInput.java
@@ -16,14 +16,33 @@ import org.eclipse.emf.cdo.view.CDOView;
import org.eclipse.ui.IEditorInput;
/**
+ * An specialized {@link org.eclipse.ui.IEditorInput IEditorInput} for the CDO editor. A <code>CDOEditorInput</code> is
+ * associated with a {@link org.eclipse.emf.cdo.eresource.CDOResource CDOResource}, accessed through a
+ * {@link org.eclipse.emf.cdo.view.CDOView CDOView} instance.
+ * <p>
+ * For related operations, see
+ * {@link org.eclipse.emf.cdo.ui.CDOEditorUtil#createCDOEditorInput(CDOView, String, boolean) CDOEditorUtil}
+ *
* @author Victor Roldan Betancort
* @since 2.0
+ * @see org.eclipse.ui.IEditorInput
+ * @see org.eclipse.emf.cdo.ui.CDOEditorUtil
+ * @see org.eclipse.emf.cdo.view.CDOView
*/
public interface CDOEditorInput extends IEditorInput
{
+ /**
+ * Returns the CDOView associated with this CDOEditorInput
+ */
public CDOView getView();
+ /**
+ * Returns true if the CDO editor instance is responsible for the underlying org.eclipse.emf.cdo.view.CDOView
+ */
public boolean isViewOwned();
+ /**
+ * Returns the path to the
+ */
public String getResourcePath();
}
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEventHandler.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEventHandler.java
index 5b99596808..9278ddf344 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEventHandler.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOEventHandler.java
@@ -41,7 +41,12 @@ import java.util.List;
import java.util.Set;
/**
+ * A class that handles {@link org.eclipse.net4j.util.event.IEvent events} on
+ * {@link org.eclipse.jface.viewers.TreeViewer TreeViewer}-based editors or views.
+ *
* @author Eike Stepper
+ * @see org.eclipse.net4j.util.event.IEvent
+ * @see org.eclipse.jface.viewers.TreeViewer
*/
public class CDOEventHandler
{
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOInteractiveExceptionHandler.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOInteractiveExceptionHandler.java
index e60d305f63..908e3b8afe 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOInteractiveExceptionHandler.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOInteractiveExceptionHandler.java
@@ -35,8 +35,12 @@ import org.eclipse.swt.widgets.Text;
import java.text.MessageFormat;
/**
+ * A <code>CDOSession</code> {@link org.eclipse.emf.cdo.session.CDOSession.ExceptionHandler ExceptionHandler}
+ * implementation that shows exception information on a UI {@link ExceptionDialog dialog}
+ *
* @author Eike Stepper
* @since 2.0
+ * @see org.eclipse.emf.cdo.session.CDOSession.ExceptionHandler
*/
public class CDOInteractiveExceptionHandler implements CDOSession.ExceptionHandler, IElementProcessor
{
@@ -119,7 +123,10 @@ public class CDOInteractiveExceptionHandler implements CDOSession.ExceptionHandl
}
/**
+ * A dialog that shows CDO related exceptions in a convenient manner.
+ *
* @author Eike Stepper
+ * @see org.eclipse.emf.cdo.ui.CDOInteractiveExceptionHandler
*/
public static class ExceptionDialog extends TitleAreaDialog
{
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOItemProvider.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOItemProvider.java
index 865f24fed1..adafb06bd2 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOItemProvider.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOItemProvider.java
@@ -79,7 +79,17 @@ import java.util.Comparator;
import java.util.List;
/**
+ * Implements multiple functionality related with UI representation of basic CDO concepts on
+ * {@link org.eclipse.jface.viewers.TreeViewer TreeViewer}-based editors and views.
+ * <p>
+ * For instance, behaves as {@link org.eclipse.jface.viewers.IContentProvider content} and
+ * {@link org.eclipse.jface.viewers.ILabelProvider label} provider for concepts such as {@link CDOSession},
+ * {@link CDOView}, {@link CDOResource} and {@link CDOResourceFolder}. It also providers common context menu action over
+ * those elements.
+ *
* @author Eike Stepper
+ * @see org.eclipse.jface.viewers.IContentProvider
+ * @see org.eclipse.jface.viewers.ILabelProvider
*/
public class CDOItemProvider extends ContainerItemProvider<IContainer<Object>>
{
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOLabelProvider.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOLabelProvider.java
index 26eda5d2bf..1a67749bed 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOLabelProvider.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/CDOLabelProvider.java
@@ -28,7 +28,15 @@ import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
/**
+ * A {@link org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider AdapterFactoryLabelProvider} specialization
+ * that decorates {@link org.eclipse.emf.cdo.CDOObject objects} with a color/font code according to their current
+ * {@link org.eclipse.emf.cdo.CDOState state}.
+ *
* @author Eike Stepper
+ * @see org.eclipse.jface.viewers.IColorProvider
+ * @see org.eclipse.jface.viewers.IFontProvider
+ * @see org.eclipse.emf.cdo.CDOObject
+ * @see org.eclipse.emf.cdo.CDOState
*/
public class CDOLabelProvider extends AdapterFactoryLabelProvider implements IColorProvider, IFontProvider
{
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/AuditScale.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/AuditScale.java
index e791acc8e6..4946ccac43 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/AuditScale.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/AuditScale.java
@@ -20,6 +20,9 @@ import org.eclipse.swt.widgets.Scale;
import org.eclipse.swt.widgets.Shell;
/**
+ * UI Widget representing all the historical revisions available for a
+ * {@link org.eclipse.emf.cdo.common.branch.CDOBranch branch}.
+ *
* @author Eike Stepper
* @since 2.0
*/
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/ComposeBranchPointComposite.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/ComposeBranchPointComposite.java
index f243559ecf..08ea728254 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/ComposeBranchPointComposite.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/ComposeBranchPointComposite.java
@@ -22,6 +22,10 @@ import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
/**
+ * Composed UI widget offering functionality for users to select {@link org.eclipse.emf.cdo.common.branch.CDOBranch
+ * branches} and a {@link org.eclipse.emf.cdo.common.branch.CDOBranchPoint timestamp} within a branch for a particular
+ * {@link org.eclipse.emf.cdo.session.CDOSession CDOSession}
+ *
* @author Eike Stepper
* @since 4.0
*/
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectBranchComposite.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectBranchComposite.java
index e24dc7d48e..35c33fc85a 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectBranchComposite.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectBranchComposite.java
@@ -37,6 +37,9 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Listener;
/**
+ * UI widget that provides visualization of all available {@link org.eclipse.emf.cdo.common.branch.CDOBranch branches},
+ * and with the capability to select one.
+ *
* @author Eike Stepper
* @since 4.0
*/
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectTimeStampComposite.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectTimeStampComposite.java
index a39027c78e..1a3f25b314 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectTimeStampComposite.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SelectTimeStampComposite.java
@@ -40,6 +40,9 @@ import org.eclipse.swt.widgets.Text;
import java.text.ParseException;
/**
+ * UI widget allowing users to indicate {@link org.eclipse.emf.cdo.common.branch.CDOBranchPoint timestamp} of a
+ * particular historical state of a {@link org.eclipse.emf.cdo.common.branch.CDOBranch branch}
+ *
* @author Eike Stepper
* @since 4.0
*/
diff --git a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SessionComposite.java b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SessionComposite.java
index 4fa32e9053..be92f86123 100644
--- a/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SessionComposite.java
+++ b/plugins/org.eclipse.emf.cdo.ui/src/org/eclipse/emf/cdo/ui/widgets/SessionComposite.java
@@ -37,6 +37,10 @@ import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
/**
+ * Simple {@link org.eclipse.swt.widgets.Composite composite} allowing users to introduce connection information with a
+ * repository. The widget recalls connection history and provides some additional functionality tweakers, as automatic
+ * EPackage registration.
+ *
* @author Victor Roldan Betancort
* @since 2.0
*/
diff --git a/plugins/org.eclipse.net4j.http.common/.settings/org.eclipse.core.resources.prefs b/plugins/org.eclipse.net4j.http.common/.settings/org.eclipse.core.resources.prefs
index bc201eedd9..8cbe76c800 100644
--- a/plugins/org.eclipse.net4j.http.common/.settings/org.eclipse.core.resources.prefs
+++ b/plugins/org.eclipse.net4j.http.common/.settings/org.eclipse.core.resources.prefs
@@ -1,3 +1,3 @@
-#Mon Jul 04 13:02:44 CEST 2011
+#Tue Dec 13 11:33:57 GMT 2011
eclipse.preferences.version=1
encoding//model/org.eclipse.emf.cdo.defs.ecorediag=UTF-8

Back to the top