com.glaivestone.javax.util
Class StatusValue

java.lang.Object
  |
  +--com.glaivestone.javax.util.StatusValue

Direct Known Subclasses:

FileSystemOperationResult

public class StatusValue

extends java.lang.Object

A multi-state status value. Optionally has an associated message describing the success or failure state of the value.

The status message is usually set to explain a failure status. Frequently left null for a successful status.

Author:

Deb Lewis

Field Summary

static int	FAILED
static int	PARTIALLY_SUCCEEDED
static int	SUCCEEDED
static StatusValue	SUCCESS_RESULT

Constructor Summary

StatusValue(int statusCode)
Create a new status value with the specified status code.

StatusValue(int statusCode, java.lang.String message)
Create a new status value with the specified status code and descriptive message.

Method Summary

boolean	failed() Answer whether the status indicates failure.
java.lang.String	getMessage() Answer the message describing this status value.
int	getStatusCode() Answer the status code.
void	setMessage(java.lang.String message) Specify the message describing this status value.
boolean	succeeded() Answer whether the status indicates success.
boolean	succeededCompletely() Answer whether the status indicates complete success.
boolean	succeededPartially() Answer whether the status indicates partial success.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUCCEEDED

public static final int SUCCEEDED

See Also:

Constant Field Values

FAILED

public static final int FAILED

See Also:

Constant Field Values

PARTIALLY_SUCCEEDED

public static final int PARTIALLY_SUCCEEDED

See Also:

Constant Field Values

SUCCESS_RESULT

public static final StatusValue SUCCESS_RESULT

Constructor Detail

StatusValue

public StatusValue(int statusCode)

Create a new status value with the specified status code.

StatusValue

public StatusValue(int statusCode,
                   java.lang.String message)

Create a new status value with the specified status code and descriptive message.

Method Detail

failed

public boolean failed()

Answer whether the status indicates failure.

getMessage

public java.lang.String getMessage()

Answer the message describing this status value.

getStatusCode

public int getStatusCode()

Answer the status code.

setMessage

public void setMessage(java.lang.String message)

Specify the message describing this status value.

succeeded

public boolean succeeded()

Answer whether the status indicates success.

The default semantics of success is that only complete success is deemed acceptable. Subclasses may allow a more forgiving point of view and allow cases of partial success to be deemed successful.

succeededCompletely

public boolean succeededCompletely()

Answer whether the status indicates complete success.

succeededPartially

public boolean succeededPartially()

Answer whether the status indicates partial success.