Module church.i18n.processing.exception

Package church.i18n.processing.message

Class ProcessingMessageOptionalBuilder

java.lang.Object

church.i18n.processing.message.ProcessingMessageAbstractBuilder<ProcessingMessageBuilder<Optional<ProcessingMessage>>>

church.i18n.processing.message.ProcessingMessageOptionalBuilder

All Implemented Interfaces:

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

public class ProcessingMessageOptionalBuilder
extends ProcessingMessageAbstractBuilder<ProcessingMessageBuilder<Optional<ProcessingMessage>>>
implements ProcessingMessageBuilder<Optional<ProcessingMessage>>

Processing message builder implementation. The builder method returns non-empty Optional with an instance of built ProcessingMessage.

Field Summary

Fields inherited from class church.i18n.processing.message.ProcessingMessageAbstractBuilder

contextInfo, helpUri, message, messageType, securityLevel

Constructor Summary

Constructors

Constructor	Description
ProcessingMessageOptionalBuilder(@NotNull I18nMessage message)	Build a processing message from provided message.
ProcessingMessageOptionalBuilder(@NotNull ProcessingMessage processingMessage)	Copy constructor for the ProcessingMessage object.
ProcessingMessageOptionalBuilder(@NotNull String code, @Nullable Object... params)	Build a processing message from code and it's message parameters.

Method Summary

Modifier and Type	Method	Description
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()

Methods inherited from class church.i18n.processing.message.ProcessingMessageAbstractBuilder

addContextInfo, addContextInfo, equals, hashCode, withHelpUri, withHelpUri, withMessageType, withSecurityLevel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface church.i18n.processing.message.ProcessingMessageBuilderMethods

addContextInfo, addContextInfo, withHelpUri, withHelpUri, withMessageType, withSecurityLevel

Constructor Details

ProcessingMessageOptionalBuilder

public ProcessingMessageOptionalBuilder(@NotNull
 @NotNull String code,
 @Nullable
 @Nullable Object... params)

Build a processing message from code and it's message parameters.

Parameters:

code - The code reference in the localization property file; or a raw message that could contain parameters.

params - Parameters that needs to be provided to properly format the message with all parameters.

See Also:

• I18nMessage(String, Object...)

ProcessingMessageOptionalBuilder

public ProcessingMessageOptionalBuilder(@NotNull
 @NotNull I18nMessage message)

Build a processing message from provided message.

Parameters:

message - Raw unformatted response message.

ProcessingMessageOptionalBuilder

public ProcessingMessageOptionalBuilder(@NotNull
 @NotNull ProcessingMessage processingMessage)

Copy constructor for the ProcessingMessage object.

Parameters:

processingMessage - A processing message to copy.

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.

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 ProcessingMessageAbstractBuilder<ProcessingMessageBuilder<Optional<ProcessingMessage>>>