Index

A B E F G I M N O R S T V
All Classes and Interfaces|All Packages

A

add(Object) - Method in class io.github.chrimle.exceptionfactory.MessageBuilder

Adds a string representation of the object, via Object.toString(), to this builder.

addCodeQuote(Object) - Method in class io.github.chrimle.exceptionfactory.MessageBuilder

Adds a code quoted string representation of the object, within ``-quotes, to this builder.

addFormatSpecifier(Class<?>) - Method in class io.github.chrimle.exceptionfactory.MessageBuilder

Adds a format specifier, based on the formatClass, to this builder.

B

build() - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

E

ExceptionBuilder<T extends Exception> - Class in io.github.chrimle.exceptionfactory

Builder of Exceptions.

ExceptionFactory - Class in io.github.chrimle.exceptionfactory

Factory of Exceptions and sub-classes.

F

format(String) - Method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Creates a formatted String from the template and arg.

format(String, String) - Method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Creates a formatted String from the template and arg.

G

getTemplate() - Method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Returns the template of this constant.

getTemplate() - Method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Returns the template of this constant.

I

illegalArgumentOf(String, MessageTemplates.OneArgTemplate) - Static method in class io.github.chrimle.exceptionfactory.ExceptionFactory

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

illegalArgumentOf(String, MessageTemplates.TwoArgTemplate, String) - Static method in class io.github.chrimle.exceptionfactory.ExceptionFactory

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

illegalStateOf(String, MessageTemplates.OneArgTemplate) - Static method in class io.github.chrimle.exceptionfactory.ExceptionFactory

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

illegalStateOf(String, MessageTemplates.TwoArgTemplate, String) - Static method in class io.github.chrimle.exceptionfactory.ExceptionFactory

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

io.github.chrimle.exceptionfactory - package io.github.chrimle.exceptionfactory

M

MAY - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.OPTIONAL.

MessageBuilder - Class in io.github.chrimle.exceptionfactory

Builder of message strings.

MessageTemplates - Class in io.github.chrimle.exceptionfactory

A collection of preset message-templates.

MessageTemplates.OneArgTemplate - Enum Class in io.github.chrimle.exceptionfactory

Template requiring ONE template specifier to format a message.

MessageTemplates.TwoArgTemplate - Enum Class in io.github.chrimle.exceptionfactory

Template requiring TWO template specifiers to format a message.

MUST - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.SHALL and RequirementLevel.REQUIRED.

MUST_BE_AT_LEAST - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_AT_MOST - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_EQUAL_TO - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_FALSE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_BE_GREATER_THAN - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_INSTANCE_OF - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_LESS_THAN - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_NEGATIVE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_BE_OF_LENGTH - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_OF_SIZE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_BE_POSITIVE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_BE_TRUE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_BE_UNIQUE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_BE_VALID - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_CONTAIN - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_EXIST - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_MATCH_REGEX - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_NOT - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.SHALL_NOT.

MUST_NOT_BE_EMPTY - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_NOT_BE_EQUAL_TO - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_NOT_BE_INSTANCE_OF - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_NOT_BE_NEGATIVE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_NOT_BE_NULL - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_NOT_BE_POSITIVE - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

MUST_NOT_CONTAIN - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Example:

MUST_NOT_EXIST - Enum constant in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Example:

N

newMessageBuilder() - Static method in class io.github.chrimle.exceptionfactory.MessageBuilder

Factory method for instantiating MessageBuilder.

NOT_RECOMMENDED - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.SHOULD_NOT.

O

of(Class<C>) - Static method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

OPTIONAL - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.MAY.

R

RECOMMENDED - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.SHOULD.

REQUIRED - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.MUST and RequirementLevel.SHALL.

RequirementLevel - Enum Class in io.github.chrimle.exceptionfactory

Keywords to indicate requirement levels, as described in RFC 2119.

S

setCause(Throwable) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

Sets the cause to be used when instantiating ExceptionBuilder,

setMessage(String) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

Sets the message to be used when instantiating ExceptionBuilder.

setMessage(MessageTemplates.OneArgTemplate, String) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

setMessage(MessageTemplates.TwoArgTemplate, String, String) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

setMessage(String, String...) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

setMessage(BiFunction<String, String, String>, String, String) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

setMessage(UnaryOperator<String>, String) - Method in class io.github.chrimle.exceptionfactory.ExceptionBuilder

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

SHALL - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.MUST and RequirementLevel.REQUIRED.

SHALL_NOT - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.MUST_NOT.

SHOULD - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.RECOMMENDED.

SHOULD_NOT - Enum constant in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Synonymous with RequirementLevel.NOT_RECOMMENDED.

T

toString() - Method in class io.github.chrimle.exceptionfactory.MessageBuilder

toString() - Method in enum class io.github.chrimle.exceptionfactory.RequirementLevel

V

valueOf(String) - Static method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.chrimle.exceptionfactory.RequirementLevel

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.OneArgTemplate

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

values() - Static method in enum class io.github.chrimle.exceptionfactory.MessageTemplates.TwoArgTemplate

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

values() - Static method in enum class io.github.chrimle.exceptionfactory.RequirementLevel

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

A B E F G I M N O R S T V
All Classes and Interfaces|All Packages