From 9cd938e86d45df13954c0bccae461afb0eb4cccd Mon Sep 17 00:00:00 2001
From: David McKnight <dmcknigh@ca.ibm.com>
Date: Wed, 30 May 2007 17:59:21 +0000
Subject: [PATCH] [183945] api doc

---
 .../core/model/AbstractSystemResourceSet.java |  5 ++
 .../rse/core/model/ISystemResourceSet.java    | 52 +++++++++++++++++++
 2 files changed, 57 insertions(+)

diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/AbstractSystemResourceSet.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/AbstractSystemResourceSet.java
index 27a2fb53ccf..6fc6385e6d3 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/AbstractSystemResourceSet.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/AbstractSystemResourceSet.java
@@ -21,6 +21,11 @@ import java.util.List;
 
 import org.eclipse.rse.services.clientserver.messages.SystemMessage;
 
+/**
+ * The common abstract implementation of a ISystemResourceSet.  Extenders
+ * can use this to inherit the basic implementations.
+ *
+ */
 public class AbstractSystemResourceSet implements ISystemResourceSet {
 	private List _resourceSet;
 	private SystemMessage _message;
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java
index 628255b133d..c91fda22e6c 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java
@@ -20,24 +20,76 @@ import java.util.List;
 
 import org.eclipse.rse.services.clientserver.messages.SystemMessage;
 
+
+/**
+ * This interface is refers to a collection of any type of resources.  The resources
+ * may be remote RSE resources, or local workspace resources. 
+ *
+ */
 public interface ISystemResourceSet {
+	
+	/**
+	 * Returns the number of resources in the set
+	 * @return the number of resources in the set
+	 */
 	public int size();
 
+	/**
+	 * Returns the resource in the set with the specified absoluteName
+	 * @param absoluteName the path of the resource to return
+	 * @return the resource
+	 */
 	public Object get(String absoluteName);
 
+	/**
+	 * Returns the path of a specified resource.  This is the same path
+	 * that is used be the get(absoluteName) method to retrieve the object
+	 * @param obj the resource to return the path for
+	 * @return the path of the resource
+	 */
 	public String pathFor(Object obj);
 
+	/**
+	 * Returns the resource at the specified index
+	 * @param index the index of the resource to return
+	 * @return the resource
+	 */
 	public Object get(int index);
 
+	/**
+	 * Returns the set of resources as a List
+	 * @return the set of resources as a List
+	 */
 	public List getResourceSet();
 
+	/**
+	 * Returns a message if a problem occurs when using this resource set
+	 * @return the message
+	 */
 	public SystemMessage getMessage();
 
+	/**
+	 * Indicates whether a message was set corresponding to this resource set
+	 * during an operation against it.
+	 * @return true if there is a message
+	 */
 	public boolean hasMessage();
 
+	/**
+	 * Indicates whether the set of resources has a size in bytes greater than zero
+	 * @return true if there are more than 0 bytes in this set
+	 */
 	public boolean hasByteSize();
 
+	/**
+	 * Returns the total number of bytes in this collection of resources
+	 * @return the number of bytes
+	 */
 	public long byteSize();
 
+	/**
+	 * Sets the total number of bytes in this collection of resources
+	 * @param byteSize the number of bytes
+	 */
 	public void setByteSize(long byteSize);
 }
\ No newline at end of file