com.technia.tvc.core

Class TVCException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.technia.tvc.core.TVCException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JPOUtils.JPOInvokeException, MailMessageFactoryUnavailable, TxException

public class TVCException
extends java.lang.Exception

Common exception that can be thrown from a variety of classes. The main features of this class is the way it encapsulates mql errors and matrix.util.MatrixException instances by stripping unwanted and unnecessary information from it's error message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TVCException() Default constructor.
TVCException(matrix.util.MatrixException rootCause) Constructor that sets the error message from that found in the provided MatrixException, unnecessary information from the error message is stripped.
TVCException(matrix.db.MQLCommand cmd) Constructor that sets the error message from that found in the provided MQLCommand, unnecessary information from the error message is stripped.
TVCException(java.lang.String message) Constructor that sets the error message to the provided String.
TVCException(java.lang.String message, java.lang.String messageKey) Create a new exception.
TVCException(java.lang.String message, java.lang.String messageKey, java.lang.Object[] messageArgs) Create a new exception.
TVCException(java.lang.String message, java.lang.Throwable rootCause) Sets the error message and root exception.
TVCException(java.lang.String message, java.lang.Throwable rootCause, java.lang.String messageKey, java.lang.Object[] messageArgs) Create a new exception.
TVCException(java.lang.Throwable rootCause) Constructor that sets the error message from that found in the provided Exception.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getExceptionMessage(java.lang.Throwable e) Returns the exception message.
java.lang.Object[]	getMessageArgs() Returns the arguments that should be used when resolving the message key into a message.
java.lang.String	getMessageKey() Returns the message key that will be resolved to a message.
java.lang.Exception	getRoot() Deprecated. Use Throwable.getCause() instead
boolean	hasCause() Returns true if this exception was caused by another.The exception that caused this can be retrieved by calling Throwable.getCause().
boolean	hasRoot() Deprecated. Use hasCause() instead

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TVCException

public TVCException(matrix.db.MQLCommand cmd)

Constructor that sets the error message from that found in the provided MQLCommand, unnecessary information from the error message is stripped.

Parameters:

cmd - the MQLCommand that holds the error information.

TVCException

public TVCException(matrix.util.MatrixException rootCause)

Constructor that sets the error message from that found in the provided MatrixException, unnecessary information from the error message is stripped.

Parameters:

rootCause - the MatrixException that holds the error information.

TVCException

public TVCException()

Default constructor.

TVCException

public TVCException(java.lang.String message)

Constructor that sets the error message to the provided String.

Parameters:

message - the error message.

TVCException

public TVCException(java.lang.Throwable rootCause)

Constructor that sets the error message from that found in the provided Exception.

Parameters:

rootCause - the Exception that caused this.

TVCException

public TVCException(java.lang.String message,
                    java.lang.Throwable rootCause)

Sets the error message and root exception.

TVCException

public TVCException(java.lang.String message,
                    java.lang.String messageKey)

Create a new exception.

Parameters:

message - The message.

messageKey - The message key (for internationalized messages).

Since:

5.0.0

TVCException

public TVCException(java.lang.String message,
                    java.lang.String messageKey,
                    java.lang.Object[] messageArgs)

Create a new exception.

Parameters:

message - The message.

messageKey - The message key (for internationalized messages).

messageArgs - The arguments used when resolving the message key into a message.

Since:

5.0.0

TVCException

public TVCException(java.lang.String message,
                    java.lang.Throwable rootCause,
                    java.lang.String messageKey,
                    java.lang.Object[] messageArgs)

Create a new exception.

Parameters:

message - The message.

rootCause - The root cause.

messageKey - The message key (for internationalized messages).

messageArgs - The arguments used when resolving the message key into a message.

Since:

5.0.0

Method Detail

hasCause

public boolean hasCause()

Returns true if this exception was caused by another.The exception that caused this can be retrieved by calling Throwable.getCause().

Returns:

true if this exception was caused by another

hasRoot

@Deprecated
public boolean hasRoot()

Deprecated. Use hasCause() instead

DEPRECATED METHOD. WILL BE REMOVED
Returns true if this exception was caused by another. The exception that caused this can be retrieved by calling getRoot().

Returns:

true if this exception was caused by another.

getRoot

@Deprecated
public java.lang.Exception getRoot()

Deprecated. Use Throwable.getCause() instead

DEPRECATED METHOD. WILL BE REMOVED
Returns the exception that caused this. Note that this method returns null if hasRoot() returns false.

Returns:

the exception that caused this.

getMessageKey

public java.lang.String getMessageKey()

Returns the message key that will be resolved to a message.

Since:

5.0.0

getMessageArgs

public java.lang.Object[] getMessageArgs()

Returns the arguments that should be used when resolving the message key into a message.

Since:

5.0.0

getExceptionMessage

protected static java.lang.String getExceptionMessage(java.lang.Throwable e)

Returns the exception message.

Parameters:

e - The exception.

Returns:

The message.