planetj.exception
Class CMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--planetj.exception.CMException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConcurrentAlterationException, DatabaseException, DataEngineException, DataEngineInitializationException, DistributedException, NoSuchTimerException, SignOnAttemptsExhausted, ValidationException

public class CMException

extends Exception

Common exception that can be used as a generic Exception. First and second level text can be assigned to the message and detailedMessage properties.

See Also:

Serialized Form

Field Summary

static int	DISPLAY_ALL
static int	DISPLAY_CLASS_INFO
static int	DISPLAY_DETAILED_MESSAGE
static int	DISPLAY_MESSAGE
static int	DISPLAY_ORIGINAL_EXCEPTION
static char	FATAL
static char	INFO
static String	SHOW_EXCEPTION
static char	WARNING

Constructor Summary

CMException()
CMException constructor comment.

CMException(Exception e)
Constructor that wraps a generic exception

CMException(Exception e, String pMessage)
Constructor that wraps a generic exception

CMException(String s)
CMException constructor comment.

CMException(String s, char c)
CMException constructor comment.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) The addPropertyChangeListener method was generated to support the propertyChange field.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) The firePropertyChange method was generated to support the propertyChange field.
CMMessage	getCMMessage() Return the CM message associated with this Exception
String	getDetailedMessage() Gets the detailedMessage property (java.lang.String) value.
String	getDisplayString() Returns the exception output as it should be displayed
int	getDisplayType() Gets what information should be included in the output of the getDisplayString() method
String	getMessage() Gets the message property (java.lang.String) value.
CMException	getNextException() Retrieves the exception chained to this CMException object.
Exception	getOriginalException() Gets the original exception that this CMException was created from.
char	getType() Gets the type property (char) value.
void	removePropertyChangeListener(PropertyChangeListener listener) The removePropertyChangeListener method was generated to support the propertyChange field.
void	setDetailedMessage(String detailedMessage) Sets the detailedMessage property (java.lang.String) value.
void	setDisplayType(int newDisplayType) Gets what information should be included in the output of the getDisplayString() method
void	setMessage(String message) Sets the message property (java.lang.String) value.
void	setNextException(CMException exception) Adds a CMException object to the end of the chain.
void	setOriginalException(Exception newOriginalException) Sets the original exception that this CMException was created from.
void	setType(char type) Sets the type property (char) value.
String	toString() Returns the exception output as a String.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

INFO

public static final char INFO

See Also:

Constant Field Values

WARNING

public static final char WARNING

See Also:

Constant Field Values

FATAL

public static final char FATAL

See Also:

Constant Field Values

SHOW_EXCEPTION

public static final String SHOW_EXCEPTION

See Also:

Constant Field Values

DISPLAY_CLASS_INFO

public static final int DISPLAY_CLASS_INFO

See Also:

Constant Field Values

DISPLAY_MESSAGE

public static final int DISPLAY_MESSAGE

See Also:

Constant Field Values

DISPLAY_DETAILED_MESSAGE

public static final int DISPLAY_DETAILED_MESSAGE

See Also:

Constant Field Values

DISPLAY_ORIGINAL_EXCEPTION

public static final int DISPLAY_ORIGINAL_EXCEPTION

See Also:

Constant Field Values

DISPLAY_ALL

public static final int DISPLAY_ALL

See Also:

Constant Field Values

Constructor Detail

CMException

public CMException()

CMException constructor comment.

CMException

public CMException(Exception e)

Constructor that wraps a generic exception

CMException

public CMException(Exception e,
                   String pMessage)

Constructor that wraps a generic exception

CMException

public CMException(String s)

CMException constructor comment.

Parameters:

s - java.lang.String

CMException

public CMException(String s,
                   char c)

CMException constructor comment.

Parameters:

s - java.lang.String

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

The addPropertyChangeListener method was generated to support the propertyChange field.

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)

The firePropertyChange method was generated to support the propertyChange field.

getCMMessage

public CMMessage getCMMessage()

Return the CM message associated with this Exception

getDetailedMessage

public String getDetailedMessage()

Gets the detailedMessage property (java.lang.String) value.

Returns:

The detailedMessage property value.

See Also:

setDetailedMessage(java.lang.String)

getDisplayString

public String getDisplayString()

Returns the exception output as it should be displayed

Returns:

java.lang.String

getDisplayType

public int getDisplayType()

Gets what information should be included in the output of the getDisplayString() method

getMessage

public String getMessage()

Gets the message property (java.lang.String) value.

Overrides:

getMessage in class Throwable

Returns:

The message property value.

See Also:

setMessage(java.lang.String)

getNextException

public CMException getNextException()

Retrieves the exception chained to this CMException object.

Returns:

the next CMException in the chain; null if none

getOriginalException

public Exception getOriginalException()

Gets the original exception that this CMException was created from. Creation date: (10/25/2001 6:48:10 PM)

Returns:

the java.lang.Exception that this CMException encapsulates. Returns null if this was created from scratch.

getType

public char getType()

Gets the type property (char) value.

Returns:

The type property value.

See Also:

setType(char)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

The removePropertyChangeListener method was generated to support the propertyChange field.

setDetailedMessage

public void setDetailedMessage(String detailedMessage)

Sets the detailedMessage property (java.lang.String) value.

Parameters:

detailedMessage - The new value for the property.

See Also:

getDetailedMessage()

setDisplayType

public void setDisplayType(int newDisplayType)

Gets what information should be included in the output of the getDisplayString() method

setMessage

public void setMessage(String message)

Sets the message property (java.lang.String) value.

Parameters:

message - The new value for the property.

See Also:

getMessage()

setNextException

public void setNextException(CMException exception)

Adds a CMException object to the end of the chain.

Parameters:

exception - the new exception that will be added to the end of the CMException chain

setOriginalException

public void setOriginalException(Exception newOriginalException)

Sets the original exception that this CMException was created from. Creation date: (10/25/2001 6:48:10 PM)

Parameters:

newOriginalException - java.lang.Exception

setType

public void setType(char type)

Sets the type property (char) value.

Parameters:

type - The new value for the property.

See Also:

getType()

toString

public String toString()

Returns the exception output as a String.

Overrides:

toString in class Throwable

Returns:

java.lang.String