Package org.palladiosimulator.generator.fluent.exceptions

Class FluentApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.palladiosimulator.generator.fluent.exceptions.FluentApiException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IllegalArgumentException, NoSuchElementException

public class FluentApiException
extends RuntimeException

Thrown by various accessor methods to indicate that the element being requested does not exist.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	FluentApiException()	Constructs a new FluentApiException with the default message.
	FluentApiException(String message)	Constructs a new FluentApiException with the specified detail message.
	FluentApiException(String message, Throwable cause)	Constructs a new FluentApiException with the specified detail message and cause.
protected	FluentApiException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace)	Constructs a new FluentApiException with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
	FluentApiException(Throwable cause)	Constructs a new FluentApiException 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

Modifier and Type	Method	Description
protected static <T> T	requireNonNull(T obj, Supplier<FluentApiException> constructor)	Checks that the specified object reference is not null and throws a customized FluentApiException if it is.

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

FluentApiException

public FluentApiException()

Constructs a new FluentApiException with the default message.

FluentApiException

public FluentApiException(String message)

Constructs a new FluentApiException 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.

FluentApiException

public FluentApiException(String message,
                          Throwable cause)

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

Note that the detail message associated with cause is not automatically incorporated in this runtime 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.)

FluentApiException

public FluentApiException(Throwable cause)

Constructs a new FluentApiException 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 runtime org.palladiosimulator.generator.fluent.exceptions that are little more than wrappers for other throwables.

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

FluentApiException

protected FluentApiException(String message,
                             Throwable cause,
                             boolean enableSuppression,
                             boolean writableStackTrace)

Constructs a new FluentApiException with the specified detail message, cause, suppression enabled or disabled, 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.)

enableSuppression - whether or not suppression is enabled or disabled

writableStackTrace - whether or not the stack trace should be writable

Method Detail

requireNonNull

protected static <T> T requireNonNull(T obj,
                                      Supplier<FluentApiException> constructor)
                               throws FluentApiException

Checks that the specified object reference is not null and throws a customized FluentApiException if it is. This method is designed primarily for doing parameter validation in methods and constructors with multiple parameters.

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for nullity

constructor - the supplier of the exception constructor

Returns:

obj if not null

Throws:

FluentApiException - if obj is null