us.temerity.pipeline
Class PipelineException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          us.temerity.pipeline.PipelineException

All Implemented Interfaces:

Serializable

public class PipelineException
extends Exception

High level Pipeline error events which should be reported to the user.

These exceptions may be generated for a variety of non-fatal failure conditions, but should always contain a message designed to be easily understandable by the user. In other words, they shouldn't require the user to understand any of the internals of Pipeline to interpret the message.

See Also:

Serialized Form

Constructor Summary

PipelineException()
Constructs a new exception with null as its detail message.

PipelineException(String message)
Constructs a new exception with the specified detail message.

PipelineException(String message, Throwable cause)
Constructs a new exception with the specified detail message and cause.

PipelineException(String header, Throwable cause, boolean appendCause, boolean appendStack)
Constructs a new exception with the specified cause and a detail message containing a detailed message explaining the the cause of an exception.

PipelineException(Throwable cause)
Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) which typically contains the class and detail message of cause.

Method Summary

static PipelineException

getDetailedException(Throwable cause) Constructs a new exception from the specified cause that builds a detailed error message, including the stack trace.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

PipelineException

public PipelineException()

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to initCause.

PipelineException

public PipelineException(String message)

Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to initCause.

Parameters:

message - The detail message. The detail message is saved for later retrieval by the getMessage method.

PipelineException

public PipelineException(String message,
                         Throwable cause)

Constructs a new exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - The detail message. The detail message is saved for later retrieval by the getMessage method.

cause - The cause (which is saved for later retrieval by the getCause method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

PipelineException

public PipelineException(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) which typically contains the class and detail message of cause. This constructor is useful for exceptions that are little more than wrappers for other throwables.

Parameters:

cause - The cause (which is saved for later retrieval by the getCause method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

PipelineException

public PipelineException(String header,
                         Throwable cause,
                         boolean appendCause,
                         boolean appendStack)

Constructs a new exception with the specified cause and a detail message containing a detailed message explaining the the cause of an exception.

Parameters:

header - Some introductory text explaining the high-level reason for the exception to include at the start of the detail message or null to omit the header.

cause - The exception being explained. A null value is permitted and indicates that the cause is nonexistent or unknown.

appendCause - Whether to append the short exception message text to the detail message. This text will be generated by the expression (cause==null ? null : cause.toString()), which typically contains the class and a brief explanation of the cause.

appendStack - Whether to append the complete stack trace of when the exception occured to the detail message.

Method Detail

getDetailedException

public static PipelineException getDetailedException(Throwable cause)

Constructs a new exception from the specified cause that builds a detailed error message, including the stack trace.

Parameters:

cause - The cause (which is saved for later retrieval by the getCause method).

Returns:

A Pipeline Exception that contains a detailed message about why the cause was thrown including a stack trace.