org.nerd4j.utils.lang

Class RequirementFailure

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.nerd4j.utils.lang.RequirementFailure

All Implemented Interfaces:

Serializable

public class RequirementFailure
extends RuntimeException

This error is created by the {Require utility class if a given requirement fails.

Is intended to be thrown if parameter validation fails in methods and constructors.

Since:

2.0.0

Author:

Massimo Coluzzi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequirementFailure(String message) Constructs a new exception with the specified detail message.
RequirementFailure(String message, Throwable cause) Constructs a new exception with the specified detail message and cause.
RequirementFailure(Throwable cause) Constructs a new exception with the specified cause and a detail message of {@code (cause==null ?

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

Constructor Detail

RequirementFailure

public RequirementFailure(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 Throwable.initCause(java.lang.Throwable).

Parameters:

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

RequirementFailure

public RequirementFailure(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()).

Parameters:

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.)

RequirementFailure

public RequirementFailure(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 (which 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 permitted, and indicates that the cause is nonexistent or unknown.)