IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.framework
Class PatternsFrameworkStatus

java.lang.Object
  extended byorg.eclipse.core.runtime.Status
      extended byorg.eclipse.core.runtime.MultiStatus
          extended bycom.ibm.xtools.patterns.framework.PatternsFrameworkStatus
All Implemented Interfaces:
org.eclipse.core.runtime.IStatus

public class PatternsFrameworkStatus
extends org.eclipse.core.runtime.MultiStatus

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


Field Summary
static int UNEXPECTED_EXCEPTION_ERROR
          Status code indicating that an unexpected exception occurred.
 
Fields inherited from class org.eclipse.core.runtime.Status
CANCEL_STATUS, OK_STATUS
 
Fields inherited from interface org.eclipse.core.runtime.IStatus
CANCEL, ERROR, INFO, OK, WARNING
 
Constructor Summary
PatternsFrameworkStatus()
          Construct a default OK status.
PatternsFrameworkStatus(int severity, int code, String message)
          Construct a status with specific settings.
PatternsFrameworkStatus(int severity, int code, String message, Throwable exception)
          Construct a status with specific settings.
 
Method Summary
static void addUnexpectedExceptionStatus(Throwable throwable, org.eclipse.core.runtime.MultiStatus status)
          Construct a status that captures an unexpected exception and add the status to the given multistatus.
 String getMessage()
           
static org.eclipse.core.runtime.IStatus UnexpectedExceptionStatus(Throwable throwable)
          Construct and return a status that captures an unexpected exception.
 
Methods inherited from class org.eclipse.core.runtime.MultiStatus
add, addAll, getChildren, isMultiStatus, merge, toString
 
Methods inherited from class org.eclipse.core.runtime.Status
getCode, getException, getPlugin, getSeverity, isOK, matches, setCode, setException, setMessage, setPlugin, setSeverity
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNEXPECTED_EXCEPTION_ERROR

public static final int UNEXPECTED_EXCEPTION_ERROR
Status code indicating that an unexpected exception occurred.

See Also:
Constant Field Values
Constructor Detail

PatternsFrameworkStatus

public PatternsFrameworkStatus()
Construct a default OK status.


PatternsFrameworkStatus

public PatternsFrameworkStatus(int severity,
                               int code,
                               String message)
Construct 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)
Construct 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

getMessage

public String getMessage()

UnexpectedExceptionStatus

public static org.eclipse.core.runtime.IStatus UnexpectedExceptionStatus(Throwable throwable)
Construct and return a status that captures an unexpected exception.

Parameters:
throwable - The unexpected exception
Returns:
a status representing an unexpected exception

addUnexpectedExceptionStatus

public static void addUnexpectedExceptionStatus(Throwable throwable,
                                                org.eclipse.core.runtime.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

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.