Module jtrim.concurrent

Package org.jtrim2.cancel

Class OperationTimeoutException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.jtrim2.cancel.OperationCanceledException

org.jtrim2.cancel.OperationTimeoutException

All Implemented Interfaces:

Serializable

public class OperationTimeoutException
extends OperationCanceledException

Defines an exception for when an operation was canceled due to timing out.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	OperationTimeoutException()	Creates the exception with null as its detail message.
	OperationTimeoutException(String message)	Creates the exception with a specific detail message.
	OperationTimeoutException(String message, Throwable cause)	Creates the exception with a specific detail message and cause.
protected	OperationTimeoutException(String message, Throwable cause, boolean writableStackTrace)	Constructs a new runtime exception with the specified detail message, cause, and writable stack trace enabled or disabled.
	OperationTimeoutException(Throwable cause)	Creates the exception with a specific cause.

Method Summary

Modifier and Type	Method	Description
static OperationTimeoutException	withoutStackTrace()	Returns a new instance of OperationTimeoutException without stack trace information.
static OperationTimeoutException	withoutStackTrace(String message, Throwable cause)	Returns a new instance of OperationTimeoutException without stack trace information.

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 Details

OperationTimeoutException

public OperationTimeoutException(Throwable cause)

Creates the exception with a specific cause. The detail message will be the string returned by the cause.toString() call.

Parameters:

cause - the causing exception of the OperationTimeoutException. The cause of OperationTimeoutException should usually be null but it is possible to specify the cause to preserve the stack trace of other exceptions signaling cancellation. This argument can be null if there is no cause.

OperationTimeoutException

public OperationTimeoutException(String message,
 Throwable cause)

Creates the exception with a specific detail message and cause.

Parameters:

message - the message to be returned by getMessage(). This argument can be null.

cause - the causing exception of the OperationTimeoutException. The cause of OperationTimeoutException should usually be null but it is possible to specify the cause to preserve the stack trace of other exceptions signaling cancellation. This argument can be null if there is no cause.

OperationTimeoutException

public OperationTimeoutException(String message)

Creates the exception with a specific detail message.

Parameters:

message - the message to be returned by getMessage(). This argument can be null.

OperationTimeoutException

public OperationTimeoutException()

Creates the exception with null as its detail message.

OperationTimeoutException

protected OperationTimeoutException(String message,
 Throwable cause,
 boolean writableStackTrace)

Constructs a new runtime exception with the specified detail message, cause, and writable stack trace enabled or disabled.

Parameters:

message - the detail message.

cause - the cause. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

writableStackTrace - whether or not the stack trace should be writable

Method Details

withoutStackTrace

public static OperationTimeoutException withoutStackTrace()

Returns a new instance of OperationTimeoutException without stack trace information. The stack trace cannot be set later.

Returns:

a new instance of OperationTimeoutException without stack trace information. This method never returns null.

withoutStackTrace

public static OperationTimeoutException withoutStackTrace(String message,
 Throwable cause)

Returns a new instance of OperationTimeoutException without stack trace information. The stack trace cannot be set later.

Parameters:

message - the message to be returned by getMessage(). This argument can be null.

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

Returns:

a new instance of TaskGraphExecutionException without stack trace information. This method never returns null.