atg.vfs.journal

Class JournalException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

atg.vfs.journal.JournalException

All Implemented Interfaces:

ContainableException, java.io.Serializable

public class JournalException
extends java.io.IOException
implements ContainableException

Exception for reporting problems encountered by the journaling file system. This exception has meta data which can be used by apps which catch it to distinguish between different error conditions.

Since this exception is thrown from a virtual file system it extends IOException which is already thrown by the virtual file system classes. This allows existing code to work and at the same time this exception can be specifically caught.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
JournalException() Empty constructor
JournalException(java.lang.String pMessage) Construct an exception with the specified message
JournalException(java.lang.String pMessage, java.lang.Throwable pSourceException) Construct an exception with the specified message and source exception
JournalException(java.lang.Throwable pSourceException) Construct an exception with the specified source exception

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Get property errorCode.
java.lang.Throwable	getSourceException() Get property sourceException.
void	printStackTrace() Prints this exception and its backtrace to the standard error stream.
void	printStackTrace(java.io.PrintStream pStream) Prints this exception and its backtrace to the specified print stream.
void	printStackTrace(java.io.PrintWriter pWriter) Prints this exception and its backtrace to the specified print writer.
void	setErrorCode(java.lang.String pErrorCode) Set property errorCode.
void	setSourceException(java.lang.Throwable pSourceException) Set property sourceException.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

JournalException

public JournalException()

Empty constructor

JournalException

public JournalException(java.lang.String pMessage)

Construct an exception with the specified message

Parameters:

pMessage - the detail message

JournalException

public JournalException(java.lang.Throwable pSourceException)

Construct an exception with the specified source exception

Parameters:

pSourceException - the source exception

JournalException

public JournalException(java.lang.String pMessage,
                        java.lang.Throwable pSourceException)

Construct an exception with the specified message and source exception

Parameters:

pMessage - the detail message

pSourceException - the source exception

Method Detail

setSourceException

public void setSourceException(java.lang.Throwable pSourceException)

Set property sourceException. This is the originally exception which is typically the cause of the error.

Parameters:

pSourceException - new value to set, may be null

getSourceException

public java.lang.Throwable getSourceException()

Get property sourceException. This is the originally exception which is typically the cause of the error.

Specified by:

getSourceException in interface ContainableException

Returns:

sourceException, may be null

setErrorCode

public void setErrorCode(java.lang.String pErrorCode)

Set property errorCode. This is the error code associated with the exception. This is either null or the resource bundle key of the associated error.

Parameters:

pErrorCode - new value to set, may be null

getErrorCode

public java.lang.String getErrorCode()

Get property errorCode. This is the error code associated with the exception. This is either null or the resource bundle key of the associated error.

Returns:

errorCode, may be null

printStackTrace

public void printStackTrace()

Prints this exception and its backtrace to the standard error stream.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream pStream)

Prints this exception and its backtrace to the specified print stream.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

pStream - PrintStream to use for output

printStackTrace

public void printStackTrace(java.io.PrintWriter pWriter)

Prints this exception and its backtrace to the specified print writer.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

pWriter - PrintWriter to use for output