Eclipse RSE Development Guide (Galileo) - ISystemResourceSet (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.model
Interface ISystemResourceSet

All Known Implementing Classes:: AbstractSystemResourceSet, SystemRemoteElementResourceSet, SystemRemoteResourceSet, SystemWorkspaceResourceSet

public interface ISystemResourceSet

This interface is refers to a collection of any type of resources. The resources may be remote RSE resources, or local workspace resources.

Method Summary

long byteSize ()
          Returns the total number of bytes in this collection of resources

Object get (int index)
          Returns the resource at the specified index

Object get ( String absoluteName)
          Returns the resource in the set with the specified absoluteName

SystemMessage getMessage ()
          Returns a message if a problem occurs when using this resource set

List getResourceSet ()
          Returns the set of resources as a List

boolean hasByteSize ()
          Indicates whether the set of resources has a size in bytes greater than zero

boolean hasMessage ()
          Indicates whether a message was set corresponding to this resource set during an operation against it.

String pathFor ( Object obj)
          Returns the path of a specified resource.

void setByteSize (long byteSize)
          Sets the total number of bytes in this collection of resources

int size ()
          Returns the number of resources in the set

Method Detail

size

int size()

Returns the number of resources in the set

Returns:: the number of resources in the set

get


Object get(
String absoluteName)

Returns the resource in the set with the specified absoluteName

Parameters:: absoluteName - the path of the resource to return
Returns:: the resource

pathFor


String pathFor(
Object obj)

Returns the path of a specified resource. This is the same path that is used be the get(absoluteName) method to retrieve the object

Parameters:: obj - the resource to return the path for
Returns:: the path of the resource

get


Object get(int index)

Returns the resource at the specified index

Parameters:: index - the index of the resource to return
Returns:: the resource

getResourceSet


List getResourceSet()

Returns the set of resources as a List

Returns:: the set of resources as a List

getMessage


SystemMessage getMessage()

Returns a message if a problem occurs when using this resource set

Returns:: the message

hasMessage

boolean hasMessage()

Indicates whether a message was set corresponding to this resource set during an operation against it.

Returns:: true if there is a message

hasByteSize

boolean hasByteSize()

Indicates whether the set of resources has a size in bytes greater than zero

Returns:: true if there are more than 0 bytes in this set

byteSize

long byteSize()

Returns the total number of bytes in this collection of resources

Returns:: the number of bytes

setByteSize

void setByteSize(long byteSize)

Sets the total number of bytes in this collection of resources

Parameters:: byteSize - the number of bytes