Module church.i18n.processing.exception

Package church.i18n.processing.exception

Class ProcessingExceptionNoopBuilder

java.lang.Object

church.i18n.processing.exception.ProcessingExceptionNoopBuilder

All Implemented Interfaces:

GenericBuilder<Optional<ProcessingException>>, ProcessingExceptionBuilder, ProcessingExceptionIntermediate<ProcessingExceptionBuilder>, ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

public class ProcessingExceptionNoopBuilder
extends Object
implements ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>, ProcessingExceptionBuilder

No operation builder. This instance is used to reduce the number of operations used during building. In the case validation condition fails, the building of an exception is not needed any more. In this case we can skip all following building operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull ProcessingExceptionBuilder	NO_OP_PROCESSING_EXCEPTION_BUILDER

Method Summary

Modifier and Type	Method	Description
@NotNull ProcessingExceptionBuilder	addContextInfo(@Nullable ContextInfo... contextInfo)	Add contextual information to the message.
@NotNull ProcessingExceptionBuilder	addContextInfo(@Nullable List<ContextInfo> contextInfo)	Add additional contextual information bounded to message.
@NotNull Optional<ProcessingException>	build()	Build an object.
void	throwException()	Builds and directly throws built exception.
@NotNull String	toString()
@NotNull ProcessingExceptionBuilder	withHelpUri(@NotNull String helpUri)	Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly.
@NotNull ProcessingExceptionBuilder	withHelpUri(@Nullable URI helpUri)	Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly.
@NotNull ProcessingExceptionBuilder	withLogLevel(@NotNull LogLevel logLevel)	Specify log level of exception.
@NotNull ProcessingExceptionBuilder	withMessageType(@Nullable MessageType messageType)	Type of message, such as severity or message status.
@NotNull ProcessingExceptionBuilder	withSecurityLevel(@Nullable SecurityLevel securityLevel)	Specify security level of information in message.
@NotNull ProcessingExceptionBuilder	withStatus(@NotNull Status status)	Specify the response status of an exception that can be used for system inter-communication.

Methods inherited from class java.lang.Object

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

Field Details

NO_OP_PROCESSING_EXCEPTION_BUILDER

@NotNull
public static final @NotNull ProcessingExceptionBuilder NO_OP_PROCESSING_EXCEPTION_BUILDER

Method Details

addContextInfo

@NotNull
public @NotNull ProcessingExceptionBuilder addContextInfo(@Nullable
 @Nullable List<ContextInfo> contextInfo)

Description copied from interface: ProcessingMessageBuilderMethods

Add additional contextual information bounded to message. It appends this contextual information to all previously added contextual information.

Specified by:

addContextInfo in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

contextInfo - Contextual information you want to provide together with the message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

addContextInfo

@NotNull
public @NotNull ProcessingExceptionBuilder addContextInfo(@Nullable
 @Nullable ContextInfo... contextInfo)

Description copied from interface: ProcessingMessageBuilderMethods

Add contextual information to the message.

Specified by:

addContextInfo in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

contextInfo - Additional contextual information appended to message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingExceptionBuilder withHelpUri(@Nullable
 @Nullable URI helpUri)

Description copied from interface: ProcessingMessageBuilderMethods

Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly. It can be reference to the documentation, KB or other article describing problem.

Specified by:

withHelpUri in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingExceptionBuilder withHelpUri(@NotNull
 @NotNull String helpUri)

Description copied from interface: ProcessingMessageBuilderMethods

Help URI associated with this message that may help receiver to find more information about the problem, better understand it and resolve it quickly. It can be reference to the documentation, KB or other article describing problem.

Specified by:

withHelpUri in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withSecurityLevel

@NotNull
public @NotNull ProcessingExceptionBuilder withSecurityLevel(@Nullable
 @Nullable SecurityLevel securityLevel)

Description copied from interface: ProcessingMessageBuilderMethods

Specify security level of information in message.

Specified by:

withSecurityLevel in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

securityLevel - Security level of information in message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withMessageType

@NotNull
public @NotNull ProcessingExceptionBuilder withMessageType(@Nullable
 @Nullable MessageType messageType)

Description copied from interface: ProcessingMessageBuilderMethods

Type of message, such as severity or message status. For more information see MessageStatus or MessageSeverity.

Specified by:

withMessageType in interface ProcessingMessageBuilderMethods<ProcessingExceptionBuilder>

Parameters:

messageType - The type of this message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

build

@NotNull
public @NotNull Optional<ProcessingException> build()

Description copied from interface: GenericBuilder

Build an object.

Specified by:

build in interface GenericBuilder<Optional<ProcessingException>>

Returns:

Build non-null object.

throwException

public void throwException()

Description copied from interface: ProcessingExceptionBuilder

Builds and directly throws built exception.

Specified by:

throwException in interface ProcessingExceptionBuilder

withLogLevel

@NotNull
public @NotNull ProcessingExceptionBuilder withLogLevel(@NotNull
 @NotNull LogLevel logLevel)

Description copied from interface: ProcessingExceptionIntermediate

Specify log level of exception.

Specified by:

withLogLevel in interface ProcessingExceptionIntermediate<ProcessingExceptionBuilder>

Parameters:

logLevel - The log level you want to use.

Returns:

An instance of object ProcessingExceptionIntermediate.

withStatus

@NotNull
public @NotNull ProcessingExceptionBuilder withStatus(@NotNull
 @NotNull Status status)

Description copied from interface: ProcessingExceptionIntermediate

Specify the response status of an exception that can be used for system inter-communication.

Specified by:

withStatus in interface ProcessingExceptionIntermediate<ProcessingExceptionBuilder>

Parameters:

status - Status associated with this exception.

Returns:

An instance of object ProcessingExceptionIntermediate.

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object