Package io.github.chrimle.exceptionfactory

Class ExceptionBuilder<T extends Exception>

java.lang.Object

io.github.chrimle.exceptionfactory.ExceptionBuilder<T>

Type Parameters:

T - Exception-class instance to build and instantiate.

public final class ExceptionBuilder<T extends Exception>
extends Object

Builder of Exceptions.

Since:

0.1.0

Author:

Chrimle

Method Summary

Modifier and Type	Method	Description
T	build()	Builds the ExceptionBuilder instance, by invoking the constructor with message and cause.
static <C extends Exception> @NotNull ExceptionBuilder<C>	of(Class<C> exceptionClass)	Creates a new ExceptionBuilder instance for building and instantiating an Exception of type ExceptionBuilder.
ExceptionBuilder<T>	setCause(@Nullable Throwable cause)	Sets the cause to be used when instantiating ExceptionBuilder,
ExceptionBuilder<T>	setMessage(@Nullable String message)	Sets the message to be used when instantiating ExceptionBuilder.
ExceptionBuilder<T>	setMessage(MessageTemplates.OneArgTemplate messageTemplate, String messageArg)	Sets the message to be used when instantiating ExceptionBuilder, by applying the messageArg to the messageTemplate.
ExceptionBuilder<T>	setMessage(MessageTemplates.TwoArgTemplate messageTemplate, String messageArgOne, String messageArgTwo)	Sets the message to be used when instantiating ExceptionBuilder, by applying the messageArgOne and messageArgTwo to the messageTemplate.
ExceptionBuilder<T>	setMessage(String formattedString, String... messageArgs)	Sets the message to be used when instantiating ExceptionBuilder, by formatting formattedString with the format specifiers messageArgs.
ExceptionBuilder<T>	setMessage(BiFunction<String,String,String> messageBuilder, @Nullable String messageArg1, @Nullable String messageArg2)	Sets the message to be used when instantiating ExceptionBuilder, by invoking messageBuilder with messageArg1 and messageArg2.
ExceptionBuilder<T>	setMessage(UnaryOperator<String> messageBuilder, @Nullable String messageArg)	Sets the message to be used when instantiating ExceptionBuilder, by invoking messageBuilder with messageArg.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

@Contract("null -> fail; _ -> new")
@NotNull
public static <C extends Exception>
@NotNull ExceptionBuilder<C> of(Class<C> exceptionClass)

Creates a new ExceptionBuilder instance for building and instantiating an Exception of type ExceptionBuilder.

Type Parameters:

C - to build and instantiate.

Parameters:

exceptionClass - to build and instantiate.

Returns:

a new ExceptionBuilder instance.

Throws:

IllegalArgumentException - if exceptionClass is null. exceptionClass MUST NOT be null.

IllegalArgumentException - if exceptionClass does not have a constructor with method arguments ExampleException(String, Throwable). exceptionClass MUST have a (String, Throwable) constructor.

Since:

0.1.0

setMessage

@Contract(value="_ -> this",
          mutates="this")
public ExceptionBuilder<T> setMessage(@Nullable
 @Nullable String message)

Sets the message to be used when instantiating ExceptionBuilder.

Parameters:

message - of the exception. MAY be null.

Returns:

this ExceptionBuilder.

Since:

0.1.0

setMessage

@Contract("null, _ -> fail; _, _ -> this")
public ExceptionBuilder<T> setMessage(UnaryOperator<String> messageBuilder,
 @Nullable
 @Nullable String messageArg)

Sets the message to be used when instantiating ExceptionBuilder, by invoking messageBuilder with messageArg.

Parameters:

messageBuilder - to invoke. MUST NOT be null.

messageArg - to invoke with. MAY be null.

Returns:

this ExceptionBuilder.

Throws:

IllegalArgumentException - if messageBuilder is null.

Since:

0.1.0

setMessage

@Contract("null, _, _ -> fail; _, _, _ -> this")
public ExceptionBuilder<T> setMessage(BiFunction<String,String,String> messageBuilder,
 @Nullable
 @Nullable String messageArg1,
 @Nullable
 @Nullable String messageArg2)

Sets the message to be used when instantiating ExceptionBuilder, by invoking messageBuilder with messageArg1 and messageArg2.

Parameters:

messageBuilder - to invoke. MUST NOT be null.

messageArg1 - to invoke with. MAY be null.

messageArg2 - to invoke with. MAY be null.

Returns:

this ExceptionBuilder.

Throws:

IllegalArgumentException - if messageBuilder is null.

Since:

0.1.0

setMessage

@Contract("null, _ -> fail; _, _ -> this")
public ExceptionBuilder<T> setMessage(String formattedString,
 String... messageArgs)

Sets the message to be used when instantiating ExceptionBuilder, by formatting formattedString with the format specifiers messageArgs.

Parameters:

formattedString - to be formatted. MUST conform to String.formatted(Object...).

messageArgs - to be used as format specifiers.

Returns:

this ExceptionBuilder.

Throws:

IllegalArgumentException - if formattedString is null.

Since:

0.1.0

See Also:

• String.formatted(Object...)

setMessage

@Contract("null, _ -> fail; _, _ -> this")
public ExceptionBuilder<T> setMessage(MessageTemplates.OneArgTemplate messageTemplate,
 String messageArg)

Sets the message to be used when instantiating ExceptionBuilder, by applying the messageArg to the messageTemplate.

Parameters:

messageTemplate - to use.

messageArg - to be supplied to the messageTemplate.

Returns:

this ExceptionBuilder.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0

setMessage

@Contract("null, _, _ -> fail; _, _, _ -> this")
public ExceptionBuilder<T> setMessage(MessageTemplates.TwoArgTemplate messageTemplate,
 String messageArgOne,
 String messageArgTwo)

Sets the message to be used when instantiating ExceptionBuilder, by applying the messageArgOne and messageArgTwo to the messageTemplate.

Parameters:

messageTemplate - to use.

messageArgOne - to be supplied to the messageTemplate.

messageArgTwo - to be supplied to the messageTemplate.

Returns:

this ExceptionBuilder.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0

setCause

@Contract(value="_ -> this",
          mutates="this")
public ExceptionBuilder<T> setCause(@Nullable
 @Nullable Throwable cause)

Sets the cause to be used when instantiating ExceptionBuilder,

Parameters:

cause - of the exception. MAY be null.

Returns:

this ExceptionBuilder.

Since:

0.1.0

build

@Contract(" -> new")
@NotNull
public T build()

Builds the ExceptionBuilder instance, by invoking the constructor with message and cause.

Returns:

the new ExceptionBuilder instance.

Since:

0.1.0