Module church.i18n.processing.exception

Package church.i18n.processing.message

Class ProcessingMessageNoopBuilder

java.lang.Object

church.i18n.processing.message.ProcessingMessageNoopBuilder

All Implemented Interfaces:

GenericBuilder<Optional<ProcessingMessage>>, ProcessingMessageBuilder<Optional<ProcessingMessage>>, ProcessingMessageBuilderMethods<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

public class ProcessingMessageNoopBuilder
extends Object
implements ProcessingMessageBuilder<Optional<ProcessingMessage>>, ProcessingMessageBuilderMethods<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

A processing message builder that only implements interface and does not do any action on provided parameters. This is used for Validator when provided condition is not met, the building of an exception does not make sense any more. The build method returns Optional.empty() and other terminal methods has no side effects.

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>>	NO_OP_PROCESSING_MESSAGE_BUILDER

Method Summary

Modifier and Type	Method	Description
@NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>>	addContextInfo(@Nullable ContextInfo... contextInfo)	Add contextual information to the message.
@NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>>	addContextInfo(@Nullable List<ContextInfo> contextInfo)	Add additional contextual information bounded to message.
void	addToMessageStorage(@NotNull MessageStorage storage)	It's terminal action of building when the message is not directly returned to the consumer, rather placed into a message storage directly.
@NotNull Optional<ProcessingMessage>	build()	Build an object.
@NotNull String	toString()
@NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>>	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 ProcessingMessageBuilder<Optional<ProcessingMessage>>	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 ProcessingMessageBuilder<Optional<ProcessingMessage>>	withMessageType(@Nullable MessageType messageType)	Type of message, such as severity or message status.
@NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>>	withSecurityLevel(@Nullable SecurityLevel securityLevel)	Specify security level of information in message.

Methods inherited from class java.lang.Object

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

Field Details

NO_OP_PROCESSING_MESSAGE_BUILDER

@NotNull
public static final @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> NO_OP_PROCESSING_MESSAGE_BUILDER

Method Details

addToMessageStorage

public void addToMessageStorage(@NotNull
 @NotNull MessageStorage storage)

Description copied from interface: ProcessingMessageBuilder

It's terminal action of building when the message is not directly returned to the consumer, rather placed into a message storage directly.

Specified by:

addToMessageStorage in interface ProcessingMessageBuilder<Optional<ProcessingMessage>>

Parameters:

storage - Storage of messages for current context.

addContextInfo

@NotNull
public @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> 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<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

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 ProcessingMessageBuilder<Optional<ProcessingMessage>> addContextInfo(@Nullable
 @Nullable ContextInfo... contextInfo)

Description copied from interface: ProcessingMessageBuilderMethods

Add contextual information to the message.

Specified by:

addContextInfo in interface ProcessingMessageBuilderMethods<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

Parameters:

contextInfo - Additional contextual information appended to message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> 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<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> 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<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withSecurityLevel

@NotNull
public @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> withSecurityLevel(@Nullable
 @Nullable SecurityLevel securityLevel)

Description copied from interface: ProcessingMessageBuilderMethods

Specify security level of information in message.

Specified by:

withSecurityLevel in interface ProcessingMessageBuilderMethods<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

Parameters:

securityLevel - Security level of information in message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withMessageType

@NotNull
public @NotNull ProcessingMessageBuilder<Optional<ProcessingMessage>> 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<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

Parameters:

messageType - The type of this message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

build

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

Description copied from interface: GenericBuilder

Build an object.

Specified by:

build in interface GenericBuilder<Optional<ProcessingMessage>>

Returns:

Build non-null object.

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object