Java API ReferenceClass Hierarchy | All Classes | All Fields and Methods

com.ibm.xtools.patterns.framework

Class PatternsFrameworkStatus

+-- MultiStatus
      +-- PatternsFrameworkStatus

public Class PatternsFrameworkStatus
extends MultiStatus

Represents the patterns framework status class that specializes Multistatus to provide patterns framework specific constructors and specific behavior for computing messages based on child status.


Fields
final static public intUNEXPECTED_EXCEPTION_ERROR

Status code indicating that an unexpected exception occurred.

Constructor summary
PatternsFrameworkStatus()

Constructs a default OK status.

PatternsFrameworkStatus(int severity, int code, String message)

Constructs a status with specific settings.

PatternsFrameworkStatus(int severity, int code, String message, Throwable exception)

Constructs a status with specific settings.

Method summary
voidaddUnexpectedExceptionStatus(Throwable throwable, MultiStatus status)

Construct a status that captures an unexpected exception and add the status to the given multistatus.

StringgetMessage()

Retrieves the message.

IStatusUnexpectedExceptionStatus(Throwable throwable)

Constructs and returns a status that captures an unexpected exception.

Constructor detail

PatternsFrameworkStatus

public PatternsFrameworkStatus()

Constructs a default OK status.


PatternsFrameworkStatus

public PatternsFrameworkStatus(int severity, int code, String message)

Constructs a status with specific settings.

Parameters:

severity
- The severity of the patterns framework status.
code
- The patterns framework specific status code.
message
- The text message associated with the status.

PatternsFrameworkStatus

public PatternsFrameworkStatus(int severity, int code, String message, Throwable exception)

Constructs a status with specific settings.

Parameters:

severity
- The severity of the patterns framework status.
code
- The patterns framework specific status code.
message
- The text message associated with the status
exception
- The exception associated with the status.

Method detail

addUnexpectedExceptionStatus

static public void addUnexpectedExceptionStatus(Throwable throwable, MultiStatus status)

Construct a status that captures an unexpected exception and add the status to the given multistatus.

Parameters:

throwable
- The unexpected exception
status
- The status to which the constructed status should be added

getMessage

public String getMessage()

Retrieves the message.

Returns:

A string representing the message value.

UnexpectedExceptionStatus

static public IStatus UnexpectedExceptionStatus(Throwable throwable)

Constructs and returns a status that captures an unexpected exception.

Parameters:

throwable
- The unexpected exception.

Returns:

A status representing an unexpected exception.


Feedback