Package io.github.chrimle.exceptionfactory

Class ExceptionFactory

java.lang.Object

io.github.chrimle.exceptionfactory.ExceptionFactory

public final class ExceptionFactory
extends Object

Factory of Exceptions and sub-classes.

Example Usage

Using MessageTemplates.OneArgTemplate:

 ExceptionFactory.illegalArgumentOf("username", MUST_NOT_BE_NULL);
 

Creates a IllegalArgumentException with a message as "`username` MUST NOT be `null`".

To provide a cause, use ExceptionBuilder.

Since:

0.1.0

Author:

Chrimle

See Also:

• ExceptionBuilder
• MessageTemplates

Method Summary

Modifier and Type	Method	Description
static @NotNull IllegalArgumentException	illegalArgumentOf(@Nullable String key, MessageTemplates.OneArgTemplate messageTemplate)	Creates an IllegalArgumentException instance with the message derived from the messageTemplate and key.
static @NotNull IllegalArgumentException	illegalArgumentOf(@Nullable String key, MessageTemplates.TwoArgTemplate messageTemplate, @Nullable String value)	Creates an IllegalArgumentException instance with the message derived from the messageTemplate and key.
static @NotNull IllegalStateException	illegalStateOf(@Nullable String key, MessageTemplates.OneArgTemplate messageTemplate)	Creates an IllegalStateException instance with the message derived from the messageTemplate and key.
static @NotNull IllegalStateException	illegalStateOf(@Nullable String key, MessageTemplates.TwoArgTemplate messageTemplate, @Nullable String value)	Creates an IllegalStateException instance with the message derived from the messageTemplate and key.

Methods inherited from class java.lang.Object

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

Method Details

illegalArgumentOf

@Contract("_, null -> fail; _, _ -> new")
@NotNull
public static @NotNull IllegalArgumentException illegalArgumentOf(@Nullable
 @Nullable String key,
 MessageTemplates.OneArgTemplate messageTemplate)

Creates an IllegalArgumentException instance with the message derived from the messageTemplate and key.

Parameters:

key - to include in the messageTemplate.

messageTemplate - to create the message.

Returns:

a new IllegalArgumentException instance.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0

illegalArgumentOf

@Contract("_, null, _ -> fail; _, _, _ -> new")
@NotNull
public static @NotNull IllegalArgumentException illegalArgumentOf(@Nullable
 @Nullable String key,
 MessageTemplates.TwoArgTemplate messageTemplate,
 @Nullable
 @Nullable String value)

Creates an IllegalArgumentException instance with the message derived from the messageTemplate and key.

Parameters:

key - to include in the messageTemplate.

messageTemplate - to create the message.

value - to include in the messageTemplate.

Returns:

a new IllegalArgumentException instance.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0

illegalStateOf

@Contract("_, null -> fail; _, _ -> new")
@NotNull
public static @NotNull IllegalStateException illegalStateOf(@Nullable
 @Nullable String key,
 MessageTemplates.OneArgTemplate messageTemplate)

Creates an IllegalStateException instance with the message derived from the messageTemplate and key.

Parameters:

key - to include in the messageTemplate.

messageTemplate - to create the message.

Returns:

a new IllegalStateException instance.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0

illegalStateOf

@Contract("_, null, _ -> fail; _, _, _ -> new")
@NotNull
public static @NotNull IllegalStateException illegalStateOf(@Nullable
 @Nullable String key,
 MessageTemplates.TwoArgTemplate messageTemplate,
 @Nullable
 @Nullable String value)

Creates an IllegalStateException instance with the message derived from the messageTemplate and key.

Parameters:

key - to include in the messageTemplate.

messageTemplate - to create the message.

value - to include in the messageTemplate.

Returns:

a new IllegalStateException instance.

Throws:

IllegalArgumentException - if messageTemplate is null.

Since:

0.1.0