public class WorkDir
extends java.lang.Object
The various attributes that can be associated with the work directory displayed in the following table.
Attribute Name | Attribute Description |
---|---|
path | the absolute path on the remote site to the work directory. |
total size | the total scratch space available under the work directory. |
free size | the free space available under the work directory. |
Modifier and Type | Field and Description |
---|---|
static int |
FREE_SIZE
The constant to be passed to the accessor functions to get or set the
free space available.
|
private java.lang.String |
mFreeSize
The free space available at the file system under this directory.
|
private java.lang.String |
mTotalSize
The total space available at the file system under this directory.
|
private java.lang.String |
mWorkDir
The path to the work directory.
|
static int |
TOTAL_SIZE
The constant to be passed to the accessor functions to get or set the
total space available.
|
static int |
WORKDIR
The constant to be passed to the accessor functions to get or set the
path to the work directory.
|
static java.lang.String[] |
WORKDIRINFO
Array storing the names of the attributes that are stored with the
work directory.
|
Constructor and Description |
---|
WorkDir()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getInfo(int key)
Returns the attribute value of a particular attribute of the work
directory.
|
void |
setInfo(int key,
java.lang.String value)
Sets an attribute associated with the work directory.
|
java.lang.String |
toMultiLine()
Returns the textual description of the contents of
WorkDir
object in the multiline format. |
java.lang.String |
toString()
Returns the textual description of the contents of
WorkDir
object. |
java.lang.String |
toXML()
Returns the XML description of the contents of
WorkDir
object. |
public static final java.lang.String[] WORKDIRINFO
public static final int WORKDIR
public static final int TOTAL_SIZE
public static final int FREE_SIZE
private java.lang.String mWorkDir
private java.lang.String mTotalSize
private java.lang.String mFreeSize
public WorkDir()
public java.lang.String getInfo(int key)
key
- the key/attribute name.java.lang.RuntimeException
- if illegal key defined.public void setInfo(int key, java.lang.String value) throws java.lang.RuntimeException
key
- the attribute key, which is one of the predefined keys.value
- value of the attribute.java.lang.Exception
- if illegal key defined.java.lang.RuntimeException
public java.lang.String toMultiLine()
WorkDir
object in the multiline format.public java.lang.String toString()
WorkDir
object.toString
in class java.lang.Object
public java.lang.String toXML()
WorkDir
object.