PROTOTYPE
Not reviewed yet: use at your own risk!

satin.remotelauncher
Class RemoteParamSet

java.lang.Object
  |
  +--satin.aro.AROobject
        |
        +--satin.aro.AROremoteObject
              |
              +--satin.remotelauncher.RemoteParamSet

Direct Known Subclasses:

RemoteAppParamSet, RemoteTestbedParamSet

public class RemoteParamSet
extends AROremoteObject

Provides access to parameters that reside on a remote system. This class is intended only for use by the RemoteLauncher package and the satin.testing.parameters package. It is a client-side interface to a ParamSet object that resides in the RemoteLauncher.Server.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROremoteObject

server

Fields inherited from class satin.aro.AROobject

id

Method Summary

boolean	getBoolean(java.lang.String name) Returns the value of a boolean parameter.
boolean	getBoolean(java.lang.String name, boolean defaultValue) Returns the value of a boolean parameter, or the given default.
ParamBaseElement	getElement(java.lang.String name) Returns a parameter element.
int	getInt(java.lang.String name) Returns the value of an integer parameter.
int	getInt(java.lang.String name, int defaultValue) Returns the value of an integer parameter, or the given default.
java.lang.String[]	getParamNames() Returns the list of defined parameter names.
java.lang.String	getString(java.lang.String name) Returns the value of a string parameter.
java.lang.String	getString(java.lang.String name, java.lang.String defaultValue) Returns the value of a string parameter, or the given default.
boolean	isDefined(java.lang.String name) Returns true if the named parameter exists, or false if it doesn't.

Methods inherited from class satin.aro.AROremoteObject

equals, exists, getAROclassName

Methods inherited from class satin.aro.AROobject

getID, setID, toAROstring, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isDefined

public boolean isDefined(java.lang.String name)
                  throws java.io.IOException,
                         AROexception

Returns true if the named parameter exists, or false if it doesn't.

Parameters:

name

the name of the parameter.

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws java.io.IOException,
                          AROexception

Returns the value of a boolean parameter. Throws an exception if the parameter doesn't exist.

Parameters:

name

the name of the parameter.

Returns:

the value of the parameter.

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean defaultValue)
                   throws java.io.IOException,
                          AROexception

Returns the value of a boolean parameter, or the given default.

Parameters:

name

the name of the parameter.

defaultValue

what to return if the parameter doesn't exist.

Returns:

the value of the parameter.

getInt

public int getInt(java.lang.String name)
           throws java.io.IOException,
                  AROexception

Returns the value of an integer parameter. Throws an exception if the parameter doesn't exist.

Parameters:

name

the name of the parameter.

Returns:

the value of the parameter.

getInt

public int getInt(java.lang.String name,
                  int defaultValue)
           throws java.io.IOException,
                  AROexception

Returns the value of an integer parameter, or the given default.

Parameters:

name

the name of the parameter.

defaultValue

what to return if the parameter doesn't exist.

Returns:

the value of the parameter.

getString

public java.lang.String getString(java.lang.String name)
                           throws java.io.IOException,
                                  AROexception

Returns the value of a string parameter. Throws an exception if the parameter doesn't exist.

Parameters:

name

the name of the parameter.

Returns:

the value of the parameter.

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String defaultValue)
                           throws java.io.IOException,
                                  AROexception

Returns the value of a string parameter, or the given default. Throws an exception if the parameter doesn't exist.

Parameters:

name

the name of the parameter.

defaultValue

what to return if the parameter doesn't exist.

Returns:

the value of the parameter.

getParamNames

public java.lang.String[] getParamNames()
                                 throws java.io.IOException,
                                        AROexception

Returns the list of defined parameter names.

Returns:

an array of strings containing one element for each defined parameter name.

getElement

public ParamBaseElement getElement(java.lang.String name)
                            throws java.io.IOException,
                                   AROexception,
                                   ParamError

Returns a parameter element.

Parameters:

name

the name of the parameter.

Returns:

the parameter element.

Revision History

7/10/01 Ed Stauff - added isDefined and overloads for get*** that take defaults.

6/19/01 Ed Stauff - made changes per API review.