Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorslewis2004-12-05 02:02:03 +0000
committerslewis2004-12-05 02:02:03 +0000
commit87791de674cf8a853e800b4d490abc950778b234 (patch)
tree84db67c9c52034b5b9233e9070c0f7975d2d35d2
parent5ef5f8d67f2bbfd6fd597f77085fcdeeb6236b88 (diff)
downloadorg.eclipse.ecf-87791de674cf8a853e800b4d490abc950778b234.tar.gz
org.eclipse.ecf-87791de674cf8a853e800b4d490abc950778b234.tar.xz
org.eclipse.ecf-87791de674cf8a853e800b4d490abc950778b234.zip
Added javadoc ant task (in javadoc.xml) and fixed javadocs for all core classes.
-rw-r--r--framework/bundles/org.eclipse.ecf/javadoc.xml8
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IIDentifiable.java9
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IOSGIService.java9
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObject.java38
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConfig.java9
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConnector.java6
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainer.java11
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerConfig.java20
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerListener.java6
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerTransaction.java7
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContext.java32
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectManager.java7
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerDescription.java6
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerFactory.java17
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectDescription.java5
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/BaseID.java10
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/GUID.java11
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/ID.java7
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/Namespace.java13
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/NamespacePermission.java4
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueEnqueue.java10
-rw-r--r--framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueException.java6
22 files changed, 140 insertions, 111 deletions
diff --git a/framework/bundles/org.eclipse.ecf/javadoc.xml b/framework/bundles/org.eclipse.ecf/javadoc.xml
new file mode 100644
index 000000000..8468bcc73
--- /dev/null
+++ b/framework/bundles/org.eclipse.ecf/javadoc.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project default="javadoc">
+ <target name="javadoc">
+ <javadoc access="protected" author="false" classpath="C:\eclipse\plugins\org.eclipse.osgi_3.0.0\console.jar;C:\eclipse\plugins\org.eclipse.osgi_3.0.0\eclipseAdaptor.jar;C:\eclipse\plugins\org.eclipse.osgi_3.0.0\defaultAdaptor.jar;C:\eclipse\plugins\org.eclipse.osgi_3.0.0\core.jar;C:\eclipse\plugins\org.eclipse.core.runtime_3.0.0\runtime.jar;bin;C:\eclipse\plugins\org.eclipse.osgi_3.0.0\resolver.jar;C:\eclipse\plugins\org.eclipse.osgi_3.0.0\osgi.jar" destdir="../ecf website/ecf/docs/api" doctitle="Eclipse Communications Framework (ECF)" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="org.eclipse.ecf.core.events,org.eclipse.ecf.core.util,org.eclipse.ecf.core.identity.provider,org.eclipse.ecf.core.identity,org.eclipse.ecf.core,org.eclipse.ecf.core.provider" sourcepath="src" splitindex="true" use="true" version="true">
+ <link href="http://java.sun.com/j2se/1.4.2/docs/api"/>
+ </javadoc>
+ </target>
+</project>
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IIDentifiable.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IIDentifiable.java
index 178049341..996fe5eea 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IIDentifiable.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IIDentifiable.java
@@ -2,7 +2,16 @@ package org.eclipse.ecf.core;
import org.eclipse.ecf.core.identity.ID;
+/**
+ * Defines implementing classes as being identifiable with
+ * an ECF identity.
+ *
+ */
public interface IIDentifiable {
+ /**
+ * Get the ID for this 'identifiable' object
+ * @return ID the ID for this identifiable object
+ */
public ID getID();
}
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IOSGIService.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IOSGIService.java
index 6cd35c47d..b54dc63d8 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IOSGIService.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/IOSGIService.java
@@ -15,9 +15,12 @@ import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.ServiceRegistration;
-/*
- * Interface provided to ISharedObject instances via ISharedObjectContext
- *
+/**
+ * Interaction with local OSGI services via ECF plugin.
+ * Provided to ISharedObject instances via ISharedObjectContext
+ *
+ * @see ISharedObjectConfig#getContext()
+ * @see org.osgi.framework.BundleContext
*/
public interface IOSGIService {
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObject.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObject.java
index 951169904..946b988fb 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObject.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObject.java
@@ -12,49 +12,61 @@ package org.eclipse.ecf.core;
import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.core.util.Event;
+/**
+ * Core interface for implementing components that exist within {@link ISharedObjectContainer}
+ *
+ */
public interface ISharedObject {
- /*
+ /**
* Initialize this ISharedObject. The ISharedObjectContainer for this
* ISharedObject must call this method with a non-null instance of
* ISharedObjectConfig. ISharedObject implementations can use this
* initialization to perform any initialization necessary prior to receiving
* any events (via handleEvent/s). Note that the ISharedObjectContext
* provided via the ISharedObjectConfig.getSharedObjectContext() method is
- * *not* guaranteed to allow any method calls until after this init() method
+ * not guaranteed to allow any method calls until after this init() method
* call has completed.
*
- * @param initData the initialization data passed by the
- * ISharedObjectContainer upon initialization @exception
- * SharedObjectInitException thrown by ISharedObject to halt initialization
- * prematurely. ISharedObjectContainer may respond to such an exception by
- * halt any further processing by ISharedObject
+ * @param initData
+ * the initialization data passed by the ISharedObjectContainer
+ * upon initialization
+ * @exception SharedObjectInitException
+ * thrown by ISharedObject to halt initialization.
+ * ISharedObjectContainers must respond to such an exception
+ * by halting the addition of the ISharedObject instance and
+ * treating it as <b>not </b> in the container.
*/
public void init(ISharedObjectConfig initData)
throws SharedObjectInitException;
- /*
+ /**
* Handle Event passed to this ISharedObject. The ISharedObjectContainer
* will pass events to all SharedObjects via this method and the
* handleEvents method.
*
- * @param event the Event for the ISharedObject to process
+ * @param event
+ * the Event for the ISharedObject to process
*/
public void handleEvent(Event event);
- /*
+ /**
* Handle Events passed to this ISharedObject. The ISharedObjectContainer
* will pass events to all SharedObjects via this method and the
* handleEvents method.
*
- * @param event the Events [] for the ISharedObject to process
+ * @param events
+ * the Events [] for the ISharedObject to process
*/
public void handleEvents(Event[] events);
- /*
+ /**
* Method called by the ISharedObjectContainer upon ISharedObject
* destruction. Once this method is called, no more Events will be passed to
* a ISharedObject until the init method is called again.
+ *
+ * @param containerID
+ * the ID of the container that is disposing this ISharedObject
*/
public void dispose(ID containerID);
@@ -66,7 +78,7 @@ public interface ISharedObject {
* @param clazz
* the Class of the adapter. The returned Object instance must
* implement the given clazz
- * @returns Object the adaptor object
+ * @return Object the adaptor object
*/
public Object getAdapter(Class clazz);
} \ No newline at end of file
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConfig.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConfig.java
index 95c9cef5f..fa834179a 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConfig.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConfig.java
@@ -13,6 +13,11 @@ import java.util.Map;
import org.eclipse.ecf.core.identity.ID;
+/**
+ * Configuration information provided to ISharedObject via its enclosing ISharedObjectContainer
+ *
+ * @see ISharedObject#init(ISharedObjectConfig)
+ */
public interface ISharedObjectConfig {
/**
@@ -21,7 +26,7 @@ public interface ISharedObjectConfig {
* provides a non-null ID instance in response to this method call.
*
* @return ID that ISharedObject can use for imlementing its own
- * ISharedObject.getID(). Cannot be null.
+ * ISharedObject.getID(). Must not be null.
*/
public ID getSharedObjectID();
/**
@@ -29,7 +34,7 @@ public interface ISharedObjectConfig {
* ISharedObject instance.
*
* @return the ID of the container that is the home of the primary copy of
- * the ISharedObject instance. Cannot be null.
+ * the ISharedObject instance. Must not be null.
*/
public ID getHomeContainerID();
/**
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConnector.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConnector.java
index 7e9d6ab2b..06052da93 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConnector.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectConnector.java
@@ -14,6 +14,12 @@ import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.core.util.AsynchResult;
import org.eclipse.ecf.core.util.QueueException;
+/**
+ * Implementers which represent the one-way associations between SharedObject
+ * instances within the scope of a given ISharedObjectContainer
+ *
+ * @see ISharedObjectManager#connectSharedObjects(ID, ID[])
+ */
public interface ISharedObjectConnector {
public ID getSender();
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainer.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainer.java
index 215e0d10d..c9f1cd79b 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainer.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainer.java
@@ -9,13 +9,12 @@
package org.eclipse.ecf.core;
-import java.io.IOException;
-
import org.eclipse.ecf.core.identity.ID;
-/*
- * ISharedObjectContainer. The core interface that must be implemented by all
- * instances of ISharedObjectContainer
+/**
+ * Core interface that must be implemented by all ECF container instances.
+ * Instances are typically
+ * created via {@link SharedObjectContainerFactory}
*/
public interface ISharedObjectContainer {
@@ -66,7 +65,7 @@ public interface ISharedObjectContainer {
* @param loginData
* any required login/authentication data to allow this container
* to authenticate
- * @exception IOException
+ * @exception SharedObjectContainerJoinException
* thrown if communication cannot be established with remote
* service
*/
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerConfig.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerConfig.java
index 8aa7f6e73..c4c17d727 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerConfig.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerConfig.java
@@ -11,19 +11,13 @@ package org.eclipse.ecf.core;
import java.util.Map;
-import org.eclipse.ecf.core.identity.ID;
+/**
+ * Configuration information associated with ISharedObjectContainer.
+ *
+ * @see ISharedObjectContainer#getConfig()
+ */
+public interface ISharedObjectContainerConfig extends IIDentifiable {
-public interface ISharedObjectContainerConfig {
-
- /**
- * The ID of the owner ISharedObjectContainer. Must be non-null, and the ID
- * must be unique within the namespace of the relevant set of
- * ISharedObjectContainer instances.
- *
- * @return ID the non-null ID instance that uniquely identifies the
- * ISharedObjectContainer instance that uses this config.
- */
- public ID getID();
/**
* The properties associated with the owner ISharedObjectContainer
*
@@ -35,7 +29,7 @@ public interface ISharedObjectContainerConfig {
* Returns an object which is an instance of the given class associated with
* this object.
*
- * @param adapter
+ * @param clazz
* the adapter class to lookup
* @return Object a object castable to the given class, or null if this
* object does not have an adapter for the given class
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerListener.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerListener.java
index 19fe3846d..68a1182a2 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerListener.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerListener.java
@@ -11,6 +11,12 @@ package org.eclipse.ecf.core;
import org.eclipse.ecf.core.events.ContainerEvent;
+/**
+ * Listener for objects that wish to receive events from an ISharedObjectContainer
+ * instance.
+ *
+ * @see ISharedObjectContainer#addListener(ISharedObjectContainerListener, String)
+ */
public interface ISharedObjectContainerListener {
public void handleEvent(ContainerEvent evt);
} \ No newline at end of file
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerTransaction.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerTransaction.java
index b9496a433..d7bec461a 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerTransaction.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContainerTransaction.java
@@ -9,6 +9,13 @@
package org.eclipse.ecf.core;
+/**
+ * Implementers represent a transaction associated with the creation of a SharedObject
+ * within the scope of a given SharedObjectContainer
+ *
+ * @see ISharedObjectContainer#getSharedObjectManager()
+ * @see ISharedObjectManager#createSharedObject(SharedObjectDescription, ISharedObjectContainerTransaction)
+ */
public interface ISharedObjectContainerTransaction {
public static final byte ACTIVE = 0;
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContext.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContext.java
index c41d41489..28c8412e1 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContext.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectContext.java
@@ -15,6 +15,17 @@ import java.io.Serializable;
import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.core.util.QueueEnqueue;
+/**
+ * Context reference provided to all ISharedObjects upon initialization. Implementers of
+ * this interface provide a runtime context for ISharedObject instances. Upon initialization
+ * within a container (see {@link ISharedObject#init(ISharedObjectConfig)}, ISharedObject instances
+ * can access an instance of this context by calling {@link ISharedObjectConfig#getContext()}. They
+ * then can have access to the functions provided by this context object for use in implementing
+ * their behavior.
+ *
+ * @see ISharedObject#init
+ * @see ISharedObjectConfig#getContext()
+ */
public interface ISharedObjectContext {
/**
@@ -25,7 +36,8 @@ public interface ISharedObjectContext {
public ID getContainerID();
/**
* Get the ISharedObjectManager for this context
- * @return
+ * @return ISharedObjectManager the shared object manager instance for this
+ * container. Null if none available.
*/
public ISharedObjectManager getSharedObjectManager();
/**
@@ -40,40 +52,40 @@ public interface ISharedObjectContext {
*/
public QueueEnqueue getQueue();
- /*
+ /**
* (non-Javadoc)
*
- * @see org.eclipse.ecf.core.ISharedObjectContainer#joinGroup(org.eclipse.ecf.identity.ID,
+ * @see org.eclipse.ecf.core.ISharedObjectContainer#joinGroup(org.eclipse.ecf.core.identity.ID,
* java.lang.Object)
*/
- public Object joinGroup(ID groupID, Object loginData)
+ public void joinGroup(ID groupID, Object loginData)
throws SharedObjectContainerJoinException;
- /*
+ /**
* (non-Javadoc)
*
* @see org.eclipse.ecf.core.ISharedObjectContainer#leaveGroup()
*/
public Object leaveGroup();
- /*
+ /**
* (non-Javadoc)
*
* @see org.eclipse.ecf.core.ISharedObjectContainer#getGroupID()
*/
public ID getGroupID();
- /*
+ /**
* (non-Javadoc)
*
* @see org.eclipse.ecf.core.ISharedObjectContainer#isGroupManager()
*/
public boolean isGroupManager();
- /*
+ /**
* (non-Javadoc)
*
* @see org.eclipse.ecf.core.ISharedObjectContainer#isGroupServer()
*/
public boolean isGroupServer();
- /*
+ /**
* (non-Javadoc)
*
* @see org.eclipse.ecf.core.ISharedObjectContainer#getGroupMembership()
@@ -160,7 +172,7 @@ public interface ISharedObjectContext {
* Returns an object which is an instance of the given class associated with
* this object.
*
- * @param adapter
+ * @param clazz
* the adapter class to lookup
* @return Object a object castable to the given class, or null if this
* object does not have an adapter for the given class
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectManager.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectManager.java
index fab40d3ee..143f79a85 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectManager.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/ISharedObjectManager.java
@@ -14,6 +14,11 @@ import java.util.Map;
import org.eclipse.ecf.core.identity.ID;
+/**
+ * Manager for creating, disposing, and accessing ISharedObjects from an ISharedObjectContainer.
+ *
+ * @see ISharedObjectContainer#getSharedObjectManager()
+ */
public interface ISharedObjectManager {
/**
@@ -57,7 +62,7 @@ public interface ISharedObjectManager {
* if the add cannot be accomplished for any reason
*/
public ID addSharedObject(ID sharedObjectID, ISharedObject sharedObject,
- Map dict, ISharedObjectContainerTransaction trans)
+ Map properties, ISharedObjectContainerTransaction trans)
throws SharedObjectAddException;
/**
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerDescription.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerDescription.java
index 5da30d18b..25a9feebc 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerDescription.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerDescription.java
@@ -11,6 +11,12 @@ package org.eclipse.ecf.core;
import org.eclipse.ecf.core.provider.ISharedObjectContainerInstantiator;
+/**
+ * Description of an ISharedObjectContainer factory implementation.
+ *
+ * @see SharedObjectContainerFactory#addDescription(SharedObjectContainerDescription)
+ *
+ */
public class SharedObjectContainerDescription {
protected String name;
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerFactory.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerFactory.java
index 2bc34381b..518825c65 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerFactory.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectContainerFactory.java
@@ -17,12 +17,11 @@ import org.eclipse.ecf.core.provider.ISharedObjectContainerInstantiator;
import org.eclipse.ecf.core.util.AbstractFactory;
import org.eclipse.ecf.internal.impl.standalone.StandaloneContainer;
-/*
- * Factory class for creating ISharedObjectContainer instances. This is the
- * top-level class for the org.eclipse.ecf 'asynch container' factory. The
- * static methods on this class can be used to create ISharedObjectContainer and
- * SharedObjectContainerGroup instances.
- *
+/**
+ * Factory for creating {@link ISharedObjectContainer} instances. This
+ * class provides ECF clients an entry point to constructing {@link ISharedObjectContainer}
+ * instances.
+ *
*/
public class SharedObjectContainerFactory {
@@ -187,7 +186,7 @@ public class SharedObjectContainerFactory {
* return an instance of ISharedObjectContainer</li>
* </ul>
*
- * @param desc
+ * @param descriptionName
* the SharedObjectContainerDescription name to lookup
* @return a valid instance of ISharedObjectContainer
* @throws SharedObjectContainerInstantiationException
@@ -211,7 +210,7 @@ public class SharedObjectContainerFactory {
* return an instance of ISharedObjectContainer</li>
* </ul>
*
- * @param desc
+ * @param descriptionName
* the SharedObjectContainerDescription name to lookup
* @param args
* the Object [] of arguments passed to the
@@ -238,7 +237,7 @@ public class SharedObjectContainerFactory {
* return an instance of ISharedObjectContainer</li>
* </ul>
*
- * @param desc
+ * @param descriptionName
* the SharedObjectContainerDescription name to lookup
* @param argsTypes
* the String [] of argument types of the following args
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectDescription.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectDescription.java
index eca9407c1..31798db76 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectDescription.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/SharedObjectDescription.java
@@ -15,6 +15,11 @@ import java.util.Map;
import org.eclipse.ecf.core.identity.ID;
+/**
+ * Description of an ISharedObject instance.
+ *
+ * @see org.eclipse.ecf.core.ISharedObjectManager#createSharedObject(SharedObjectDescription, ISharedObjectContainerTransaction)
+ */
public class SharedObjectDescription implements Serializable {
protected static long staticID = 0;
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/BaseID.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/BaseID.java
index 8585bdec2..297e3c3b3 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/BaseID.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/BaseID.java
@@ -14,12 +14,6 @@ import java.net.URISyntaxException;
public abstract class BaseID implements ID {
- /**
- *
- * @uml.property name="namespace"
- * @uml.associationEnd
- * @uml.property name="namespace" multiplicity="(1 1)"
- */
Namespace namespace;
protected BaseID(Namespace namespace) {
@@ -46,10 +40,6 @@ public abstract class BaseID implements ID {
return namespace.getNameForID(this);
}
- /**
- *
- * @uml.property name="namespace"
- */
public Namespace getNamespace() {
return namespace;
}
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/GUID.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/GUID.java
index 3eac78297..491aef93e 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/GUID.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/GUID.java
@@ -15,8 +15,10 @@ import org.eclipse.ecf.core.identity.provider.IDInstantiator;
import org.eclipse.ecf.core.util.Base64;
/**
- * Globally unique ID class.
- *
+ * Globally unique ID implementation class. Uses {@link java.security.SecureRandom}
+ * to create a unique number of given byte length. Default byte length for secure
+ * number is 20 bytes. Default algorithm used for creating a SecureRandom instance
+ * is SHA1PRNG.
*/
public class GUID extends StringID {
@@ -44,8 +46,9 @@ public class GUID extends StringID {
*
* @param n
* the Namespace this identity will belong to
- * @param s
- * the String defining this StringID
+ * @param provider
+ * the name of the algorithm to use. See {@link SecureRandom}
+ * @param byteLength the length of the target number (in bytes)
*/
protected GUID(Namespace n, String algo, String provider, int byteLength)
throws IDInstantiationException {
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/ID.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/ID.java
index 363d81c05..b8036e668 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/ID.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/ID.java
@@ -30,7 +30,6 @@ import java.net.URISyntaxException;
* addNamespace) in order to allow the custom creation of instances that
* implement this interface.
*
- * @author Scott B. Lewis, slewis@composent.com
*/
public interface ID extends java.io.Serializable, java.lang.Comparable,
@@ -42,8 +41,6 @@ public interface ID extends java.io.Serializable, java.lang.Comparable,
* Get the unique name of this identity.
*
* @return String unique name for this identity
- *
- * @uml.property name="name"
*/
public String getName();
@@ -51,10 +48,6 @@ public interface ID extends java.io.Serializable, java.lang.Comparable,
* Get the Namespace instance associated with this identity
*
* @return Namespace the Namespace corresponding to this identity
- *
- * @uml.property name="namespace"
- * @uml.associationEnd
- * @uml.property name="namespace" multiplicity="(0 1)"
*/
public Namespace getNamespace();
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/Namespace.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/Namespace.java
index f22168661..ef769a625 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/Namespace.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/Namespace.java
@@ -37,16 +37,6 @@ public class Namespace implements Serializable {
private transient IDInstantiator instantiator = null;
- /**
- *
- * @param name
- * the name of the Namespace
- * @param instantiatorClass
- * the fully qualified classname of the class responsible for
- * creating id instances that can exist within this namespace.
- * @param description
- * a description to be associated with this Namespace
- */
public Namespace(ClassLoader cl, String name, String instantiatorClass,
String desc) {
this.classLoader = cl;
@@ -91,8 +81,6 @@ public class Namespace implements Serializable {
* thrown if instantiator class cannot be loaded, or if it
* cannot be cast to ISharedObjectContainerInstantiator
* interface
- *
- * @uml.property name="instantiator"
*/
protected IDInstantiator getInstantiator() throws ClassNotFoundException,
InstantiationException, IllegalAccessException {
@@ -126,7 +114,6 @@ public class Namespace implements Serializable {
/**
* @return String name of Namespace instance
*
- * @uml.property name="name"
*/
public String getName() {
return name;
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/NamespacePermission.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/NamespacePermission.java
index b58e944e6..1ad36bee9 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/NamespacePermission.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/identity/NamespacePermission.java
@@ -31,10 +31,6 @@ public class NamespacePermission extends BasicPermission {
actions = s1;
}
- /**
- *
- * @uml.property name="actions"
- */
public String getActions() {
return actions;
}
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueEnqueue.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueEnqueue.java
index 3b66c68c2..68ad13419 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueEnqueue.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueEnqueue.java
@@ -20,18 +20,8 @@ public interface QueueEnqueue {
boolean enqueue_lossy(Event element);
- /**
- *
- * @uml.property name="enqueuePredicate"
- */
void setEnqueuePredicate(EnqueuePredicate pred);
- /**
- *
- * @uml.property name="enqueuePredicate"
- * @uml.associationEnd
- * @uml.property name="enqueuePredicate" multiplicity="(0 1)"
- */
EnqueuePredicate getEnqueuePredicate();
int size();
diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueException.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueException.java
index ed6aa6901..8ce5a2039 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueException.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/util/QueueException.java
@@ -11,12 +11,6 @@ package org.eclipse.ecf.core.util;
public class QueueException extends Exception {
- /**
- *
- * @uml.property name="theQueue"
- * @uml.associationEnd
- * @uml.property name="theQueue" multiplicity="(0 1)"
- */
Queue theQueue = null;
public QueueException() {

Back to the top