Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.exception

Class IllegalOperationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.tquadrat.foundation.exception.IllegalOperationException

All Implemented Interfaces:

Serializable

@ClassVersion(sourceVersion="$Id: IllegalOperationException.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public class IllegalOperationException
extends RuntimeException

This implementation of RuntimeException will be thrown when an attempted operation is not valid for the current context.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: IllegalOperationException.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.exception.IllegalOperationException"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_IllegalOperation	The message for the illegal attempt to perform an operation: "Illegal attempt to perform the operation \'%s\'".
static final String	MSG_IllegalOperationWithExplanation	The message for the illegal attempt to perform an operation, enhanced with an explanation: "Illegal attempt to perform the operation \'%s\' (Reason: %s)".

Constructor Summary

Constructors

Constructor	Description
IllegalOperationException(Method operation)	Constructs a new IllegalOperationException with a detail message composed of the name of the given operation.
IllegalOperationException(Method operation, String explanation)	Constructs a new IllegalOperationException with a detail message composed of the name of the given operation name and the given explanation.
IllegalOperationException(Method operation, String explanation, Throwable cause)	Constructs a new IllegalOperationException with the cause and a detail message composed of the name of the given operation and the given explanation.
IllegalOperationException(Method operation, Throwable cause)	Constructs a new IllegalOperationException with a detail message composed of the name of the given operation, and the cause.
IllegalOperationException(String operationName)	Constructs a new IllegalOperationException with a detail message composed of the given operation name.
IllegalOperationException(String operationName, String explanation)	Constructs a new IllegalOperationException with a detail message composed of the given operation name and the given explanation.
IllegalOperationException(String operationName, String explanation, Throwable cause)	Constructs a new IllegalOperationException with the cause and a detail message composed of the given operation name and the given explanation.
IllegalOperationException(String operationName, Throwable cause)	Constructs a new IllegalOperationException with a detail message composed of the given operation name, and the cause.

Method Summary

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

Field Details

MSG_IllegalOperation

public static final String MSG_IllegalOperation

The message for the illegal attempt to perform an operation: "Illegal attempt to perform the operation \'%s\'".

See Also:

• Constant Field Values

MSG_IllegalOperationWithExplanation

public static final String MSG_IllegalOperationWithExplanation

The message for the illegal attempt to perform an operation, enhanced with an explanation: "Illegal attempt to perform the operation \'%s\' (Reason: %s)".

See Also:

• Constant Field Values

Constructor Details

IllegalOperationException

public IllegalOperationException(String operationName)

Constructs a new IllegalOperationException with a detail message composed of the given operation name. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

operationName - The name of the illegally attempted operation; usually, this is the method name. The detail message constructed from it is saved for later retrieval by the Throwable.getMessage() method.

IllegalOperationException

public IllegalOperationException(Method operation)

Constructs a new IllegalOperationException with a detail message composed of the name of the given operation. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

operation - The illegally attempted operation. The detail message constructed from its name is saved for later retrieval by the Throwable.getMessage() method.

IllegalOperationException

public IllegalOperationException(String operationName,
 String explanation)

Constructs a new IllegalOperationException with a detail message composed of the given operation name and the given explanation. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

The detail message constructed from the operation name and the explanation is saved for later retrieval by the Throwable.getMessage() method.

Parameters:

operationName - The name of the illegally attempted operation; usually, this is the method name.

explanation - The additional explanation.

IllegalOperationException

public IllegalOperationException(Method operation,
 String explanation)

Constructs a new IllegalOperationException with a detail message composed of the name of the given operation name and the given explanation. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

The detail message constructed from the operation name and the explanation is saved for later retrieval by the Throwable.getMessage() method.

Parameters:

operation - The illegally attempted operation.

explanation - The additional explanation.

IllegalOperationException

public IllegalOperationException(String operationName,
 Throwable cause)

Constructs a new IllegalOperationException with a detail message composed of the given operation name, and the cause.

Note:

• The detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

operationName - The name of the illegally attempted operation; usually, this is the method name. The detail message constructed from it is saved for later retrieval by the Throwable.getMessage() method.

cause - The cause, which is saved for later retrieval by the Throwable.getCause() method. A null value is not permitted!

IllegalOperationException

public IllegalOperationException(Method operation,
 Throwable cause)

Constructs a new IllegalOperationException with a detail message composed of the name of the given operation, and the cause.

Note:

• The detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

operation - The illegally attempted operation. The detail message constructed from its name is saved for later retrieval by the Throwable.getMessage() method.

cause - The cause, which is saved for later retrieval by the Throwable.getCause() method. A null value is not permitted!

IllegalOperationException

public IllegalOperationException(String operationName,
 String explanation,
 Throwable cause)

Constructs a new IllegalOperationException with the cause and a detail message composed of the given operation name and the given explanation.

The detail message constructed from the operation name and the explanation is saved for later retrieval by the Throwable.getMessage() method.

Note:

• The detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

operationName - The name of the illegally attempted operation; usually, this is the method name.

explanation - The additional explanation.

cause - The cause, which is saved for later retrieval by the Throwable.getCause() method. A null value is not permitted!

IllegalOperationException

public IllegalOperationException(Method operation,
 String explanation,
 Throwable cause)

Constructs a new IllegalOperationException with the cause and a detail message composed of the name of the given operation and the given explanation.

The detail message constructed from the operation name and the explanation is saved for later retrieval by the Throwable.getMessage() method.

Note:

• The detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

operation - The illegally attempted operation.

explanation - The additional explanation.

cause - The cause, which is saved for later retrieval by the Throwable.getCause() method. A null value is not permitted!