mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-03 07:05:24 +02:00
Code Issues Wiki Activity

[183945] api doc

Browse source
This commit is contained in:
David McKnight 2007-05-30 17:59:21 +00:00
parent e927256811
commit 9cd938e86d
2 changed files with 57 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/AbstractSystemResourceSet.java
View file

@ -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;

52
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java
View file

@ -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);
}