casa

Class StatusObject<T>

java.lang.Object

casa.Status

casa.StatusObject<T>

Type Parameters:

T - the generice type so that any object can have a status

All Implemented Interfaces:

Cloneable

public class StatusObject<T>
extends Status

a class that extends the functionality of Status to include a generic object

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private T	object the object of whome's status we are concerned with

Fields inherited from class casa.Status

BAD_CONTENT_FIELD, BAD_REPLY_TO_FIELD, EXCEPTION_CAUGHT, SUCCESS, TIMEOUT, UNEXEPCTED_EXCEPTION_CAUGHT, UNKNOWN_ERROR, UNKNOWN_REPLY, UNKNOWN_WARNING

Constructor Summary

Constructors

Constructor and Description
StatusObject() the default constructor of StatusObject
StatusObject(int status, String explanation) a constructor that includes additional information
StatusObject(int status, String explanation, T obj) a constructor that includes additional information
StatusObject(int status, T obj) a constructor that includes additional information
StatusObject(T obj) a constructor that includes additional information
StatusObject(TokenParser p) a constructor for a status object of type TokenParser

Method Summary

Modifier and Type	Method and Description
boolean	containsType(Class<?> testClass) a function to check if the StatusOBject's generic object is an instance of the testClass
void	fromString_extension(TokenParser parser) To be overridden by subclasses to read any additional information from a string.
T	getObject() a function that returns the generic object of this status object (might be null if not set)
void	setObject(T obj) a function that sets the generic object of this status object
String	toString_extension() To be overridden by subclasses to write out any extended data.

Methods inherited from class casa.Status

clone, codeToString, fromString, fromString, fromString2, getExplanation, getStatusValue, main, setExplanation, setStatus, setStatusValue, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

object

private T object

the object of whome's status we are concerned with

Constructor Detail

StatusObject

public StatusObject()

the default constructor of StatusObject

StatusObject

public StatusObject(int status,
                    String explanation)

a constructor that includes additional information

Parameters:

status - the integer status we want to set to

explanation - the explanation of the status

StatusObject

public StatusObject(int status,
                    T obj)

a constructor that includes additional information

Parameters:

status - the integer status we want to set to

obj - the object who's status we are concerned with

StatusObject

public StatusObject(int status,
                    String explanation,
                    T obj)

a constructor that includes additional information

Parameters:

status - the integer status we want to set to

explanation - the explanation of the status

obj - the object who's status we are concerned with

StatusObject

public StatusObject(T obj)

a constructor that includes additional information

Parameters:

obj - the object who's status we are concerned with

StatusObject

public StatusObject(TokenParser p)
             throws Exception

a constructor for a status object of type TokenParser

Parameters:

p - the token parser to supply

Throws:

Exception - see TokenParser for information

Method Detail

getObject

public T getObject()

a function that returns the generic object of this status object (might be null if not set)

Returns:

the generic object

setObject

public void setObject(T obj)

a function that sets the generic object of this status object

Parameters:

obj - the generic object to set to

containsType

public boolean containsType(Class<?> testClass)

a function to check if the StatusOBject's generic object is an instance of the testClass

Parameters:

testClass - the testClass to see if the generic object is an instance there-of

Returns:

a boolean

toString_extension

public String toString_extension()

Description copied from class: Status

To be overridden by subclasses to write out any extended data. This method is called just be just before Status.toString() writes out the closing ')'.

Overrides:

toString_extension in class Status

Returns:

fromString_extension

public void fromString_extension(TokenParser parser)
                          throws Exception

Description copied from class: Status

To be overridden by subclasses to read any additional information from a string. This method is called just before Status.fromString() would read the closing ')'. This implementation does nothing.

Overrides:

fromString_extension in class Status

Throws:

ParseException

Exception