org.eclipse.osbp.runtime.common.validation

Class Status

java.lang.Object

org.eclipse.osbp.runtime.common.validation.Status

All Implemented Interfaces:

IStatus

public class Status
extends Object
implements IStatus

The Class Status.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.osbp.runtime.common.validation.IStatus

IStatus.Severity

Field Summary

Fields inherited from interface org.eclipse.osbp.runtime.common.validation.IStatus

CANCEL, ERROR, OK, PROP_CREATOR, PROP_FIELD_I18N_KEY, PROP_FIELD_ID, PROP_JAVAX_CONSTRAINT, PROP_JAVAX_LEAF_BEAN, PROP_JAVAX_PROPERTY_PATH, PROP_UI_APPLICATION_ID

Constructor Summary

Constructors

Constructor and Description
Status() Instantiates a new status.

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(String key) Returns true, if a property exists.
static IStatus	createCancelStatus() Creates an CANCEL status.
static IStatus	createErrorStatus() Creates an ERROR status.
static IStatus	createErrorStatus(Exception e) Creates an ERROR status.
static IStatus	createOKStatus() Creates an OK status.
static IStatus	createStatus(String code, Class<?> clazz, IStatus.Severity severity, Exception exception) Creates the status.
static IStatus	createStatus(String code, Class<?> clazz, IStatus.Severity severity, String message) Creates a status for the given parameters.
static IStatus	createStatus(String code, Class<?> clazz, IStatus.Severity severity, String message, Exception exception) Creates the status.
String	getBundleSymblicName() Returns symbolic name of the bundle that has created the status.
String	getCode() Returns the status code.
Exception	getException() Returns the exception of the status.
String	getId() Returns the id of the status.
String	getMessage() Returns the message of the status.
Object	getProperty(String key) Returns the value of the property.
IStatus.Severity	getSeverity() Returns the severity of the status.
boolean	isCancel() Returns true, if the status is IStatus.Severity.CANCEL.
boolean	isError() Returns true, if the status is IStatus.Severity.ERROR.
boolean	isInfo() Returns true, if the status is IStatus.Severity.INFO.
boolean	isOK() Returns true, if the status is IStatus.Severity.OK or IStatus.Severity.INFO.
boolean	isWarning() Returns true, if the status is IStatus.Severity.WARNING.
void	putProperty(String key, Object value) Puts a property into the status.

Methods inherited from class java.lang.Object

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

Constructor Detail

Status

public Status()

Instantiates a new status.

Method Detail

createOKStatus

public static IStatus createOKStatus()

Creates an OK status.

Returns:

the i status

createCancelStatus

public static IStatus createCancelStatus()

Creates an CANCEL status.

Returns:

the i status

createErrorStatus

public static IStatus createErrorStatus()

Creates an ERROR status.

Returns:

the i status

createErrorStatus

public static IStatus createErrorStatus(Exception e)

Creates an ERROR status.

Parameters:

e - - the exception

Returns:

the i status

createStatus

public static IStatus createStatus(String code,
                                   Class<?> clazz,
                                   IStatus.Severity severity,
                                   String message)

Creates a status for the given parameters.

Parameters:

code - - the unique message code (is unique in a bundle)

clazz - - the class that is contained in the bundle, that specifies the code

severity - - the serverity of the status

message - - the message of the status

Returns:

the i status

createStatus

public static IStatus createStatus(String code,
                                   Class<?> clazz,
                                   IStatus.Severity severity,
                                   String message,
                                   Exception exception)

Creates the status.

Parameters:

code - - the unique message code (is unique in a bundle)

clazz - - the class that is contained in the bundle, that specifies the code

severity - - the serverity of the status

message - - the message of the status

exception - - the thrown exception

Returns:

the i status

createStatus

public static IStatus createStatus(String code,
                                   Class<?> clazz,
                                   IStatus.Severity severity,
                                   Exception exception)

Creates the status.

Parameters:

code - - the unique message code (is unique in a bundle)

clazz - - the class that is contained in the bundle, that specifies the code

severity - - the serverity of the status

exception - - the thrown exception

Returns:

the i status

getId

public String getId()

Description copied from interface: IStatus

Returns the id of the status. It is prepared by the pattern {bundleSymbolicName}.{code}. So every bundle may specify its own codes.

Specified by:

getId in interface IStatus

Returns:

the id

getCode

public String getCode()

Description copied from interface: IStatus

Returns the status code. The code specifies the unique id of a status message in a bundle.

Specified by:

getCode in interface IStatus

Returns:

the code

getBundleSymblicName

public String getBundleSymblicName()

Description copied from interface: IStatus

Returns symbolic name of the bundle that has created the status.

Specified by:

getBundleSymblicName in interface IStatus

Returns:

the bundle symblic name

getSeverity

public IStatus.Severity getSeverity()

Description copied from interface: IStatus

Returns the severity of the status.

Specified by:

getSeverity in interface IStatus

Returns:

the severity

getMessage

public String getMessage()

Description copied from interface: IStatus

Returns the message of the status. May be null.

Specified by:

getMessage in interface IStatus

Returns:

the message

getException

public Exception getException()

Description copied from interface: IStatus

Returns the exception of the status. May be null.

Specified by:

getException in interface IStatus

Returns:

the exception

isOK

public boolean isOK()

Description copied from interface: IStatus

Returns true, if the status is IStatus.Severity.OK or IStatus.Severity.INFO.

Specified by:

isOK in interface IStatus

Returns:

true, if is ok

isInfo

public boolean isInfo()

Description copied from interface: IStatus

Returns true, if the status is IStatus.Severity.INFO.

Specified by:

isInfo in interface IStatus

Returns:

true, if is info

isWarning

public boolean isWarning()

Description copied from interface: IStatus

Returns true, if the status is IStatus.Severity.WARNING.

Specified by:

isWarning in interface IStatus

Returns:

true, if is warning

isError

public boolean isError()

Description copied from interface: IStatus

Returns true, if the status is IStatus.Severity.ERROR.

Specified by:

isError in interface IStatus

Returns:

true, if is error

isCancel

public boolean isCancel()

Description copied from interface: IStatus

Returns true, if the status is IStatus.Severity.CANCEL. May be used to detect a "veto" for a process.

Specified by:

isCancel in interface IStatus

Returns:

true, if is cancel

putProperty

public void putProperty(String key,
                        Object value)

Description copied from interface: IStatus

Puts a property into the status.

Specified by:

putProperty in interface IStatus

Parameters:

key - the key

value - the value

containsProperty

public boolean containsProperty(String key)

Description copied from interface: IStatus

Returns true, if a property exists.

Specified by:

containsProperty in interface IStatus

Parameters:

key - the key

Returns:

true, if successful

getProperty

public Object getProperty(String key)

Description copied from interface: IStatus

Returns the value of the property.

Specified by:

getProperty in interface IStatus

Parameters:

key - the key

Returns:

the property