Package io.github.chrimle.exceptionfactory

Enum Class MessageTemplates.TwoArgTemplate

java.lang.Object

java.lang.Enum<MessageTemplates.TwoArgTemplate>

io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

All Implemented Interfaces:

Serializable, Comparable<MessageTemplates.TwoArgTemplate>, Constable

Enclosing class:

MessageTemplates

public static enum MessageTemplates.TwoArgTemplate
extends Enum<MessageTemplates.TwoArgTemplate>

Template requiring TWO template specifiers to format a message.

Since:

0.1.0

Author:

Chrimle

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MUST_BE_AT_LEAST	Example:
MUST_BE_AT_MOST	Example:
MUST_BE_EQUAL_TO	Example:
MUST_BE_GREATER_THAN	Example:
MUST_BE_INSTANCE_OF	Example:
MUST_BE_LESS_THAN	Example:
MUST_BE_OF_LENGTH	Example:
MUST_BE_OF_SIZE	Example:
MUST_CONTAIN	Example:
MUST_MATCH_REGEX	Example:
MUST_NOT_BE_EQUAL_TO	Example:
MUST_NOT_BE_INSTANCE_OF	Example:
MUST_NOT_CONTAIN	Example:

Method Summary

Modifier and Type	Method	Description
@NotNull String	format(String argOne, String argTwo)	Creates a formatted String from the template and arg.
String	getTemplate()	Returns the template of this constant.
static MessageTemplates.TwoArgTemplate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageTemplates.TwoArgTemplate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MUST_BE_AT_LEAST

public static final MessageTemplates.TwoArgTemplate MUST_BE_AT_LEAST

Example:

"`example` MUST be at least `42`"

Since:

0.1.0

MUST_BE_AT_MOST

public static final MessageTemplates.TwoArgTemplate MUST_BE_AT_MOST

Example:

"`example` MUST be at most `42`"

Since:

0.1.0

MUST_BE_EQUAL_TO

public static final MessageTemplates.TwoArgTemplate MUST_BE_EQUAL_TO

Example:

"`actual` MUST be equal to `expected`"

Since:

0.2.0

See Also:

• MUST_NOT_BE_EQUAL_TO

MUST_BE_GREATER_THAN

public static final MessageTemplates.TwoArgTemplate MUST_BE_GREATER_THAN

Example:

"`example` MUST be greater than `42`"

Since:

0.1.0

MUST_BE_INSTANCE_OF

public static final MessageTemplates.TwoArgTemplate MUST_BE_INSTANCE_OF

Example:

"`example` MUST be an instance of `ExampleClass`"

Since:

0.2.0

See Also:

• MUST_NOT_BE_INSTANCE_OF

MUST_BE_LESS_THAN

public static final MessageTemplates.TwoArgTemplate MUST_BE_LESS_THAN

Example:

"`example` MUST be less than `42`"

Since:

0.1.0

MUST_BE_OF_LENGTH

public static final MessageTemplates.TwoArgTemplate MUST_BE_OF_LENGTH

Example:

"`example` MUST be of length `42`"

Since:

0.2.0

MUST_BE_OF_SIZE

public static final MessageTemplates.TwoArgTemplate MUST_BE_OF_SIZE

Example:

"`example` MUST be of size `42`"

Since:

0.2.0

MUST_CONTAIN

public static final MessageTemplates.TwoArgTemplate MUST_CONTAIN

Example:

"`example` MUST contain `ex`"

Since:

0.1.0

MUST_MATCH_REGEX

public static final MessageTemplates.TwoArgTemplate MUST_MATCH_REGEX

Example:

"`example` MUST match RegEx `.*`"

Since:

0.1.0

MUST_NOT_BE_EQUAL_TO

public static final MessageTemplates.TwoArgTemplate MUST_NOT_BE_EQUAL_TO

Example:

"`example` MUST NOT be equal to `example`"

Since:

0.1.0

MUST_NOT_BE_INSTANCE_OF

public static final MessageTemplates.TwoArgTemplate MUST_NOT_BE_INSTANCE_OF

Example:

"`example` MUST NOT be an instance of `ExampleClass`"

Since:

0.2.0

See Also:

• MUST_BE_INSTANCE_OF

MUST_NOT_CONTAIN

public static final MessageTemplates.TwoArgTemplate MUST_NOT_CONTAIN

Example:

"`example` MUST NOT contain `ex`"

Since:

0.1.0

Method Details

values

public static MessageTemplates.TwoArgTemplate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessageTemplates.TwoArgTemplate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTemplate

@Contract(pure=true)
public String getTemplate()

Returns the template of this constant.

Returns:

the template.

Since:

0.1.0

format

@Contract(pure=true)
@NotNull
public @NotNull String format(String argOne,
 String argTwo)

Creates a formatted String from the template and arg.

Parameters:

argOne - to be used as the first template specifier.

argTwo - to be used as the second template specifier.

Returns:

the formatted String.

Since:

0.1.0