Module church.i18n.processing.exception

Package church.i18n.processing.message

Class ProcessingMessageAbstractBuilder<T extends ProcessingMessageBuilderMethods<T>>

java.lang.Object

church.i18n.processing.message.ProcessingMessageAbstractBuilder<T>

Type Parameters:

T - Type of implemented builder for a more specific implementation.

All Implemented Interfaces:

ProcessingMessageBuilderMethods<T>

Direct Known Subclasses:

ProcessingExceptionOptionalBuilder, ProcessingMessageDefaultBuilder, ProcessingMessageOptionalBuilder

public class ProcessingMessageAbstractBuilder<T extends ProcessingMessageBuilderMethods<T>>
extends Object
implements ProcessingMessageBuilderMethods<T>

Generic builder content for Processing message.

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull List<ContextInfo>	contextInfo
protected @Nullable URI	helpUri
protected final @NotNull I18nMessage	message
protected @NotNull MessageType	messageType
protected @Nullable SecurityLevel	securityLevel

Constructor Summary

Constructors

Constructor	Description
ProcessingMessageAbstractBuilder(@NotNull I18nMessage message)
ProcessingMessageAbstractBuilder(@NotNull ProcessingMessage processingMessage)
ProcessingMessageAbstractBuilder(@NotNull String code, @Nullable Object... params)

Method Summary

Modifier and Type	Method	Description
T	addContextInfo(@Nullable ContextInfo... contextInfo)	Add contextual information to the message.
T	addContextInfo(@Nullable List<ContextInfo> contextInfo)	Add additional contextual information bounded to message.
boolean	equals(Object o)
int	hashCode()
@NotNull String	toString()
T	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.
T	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.
T	withMessageType(@NotNull MessageType messageType)	Type of message, such as severity or message status.
T	withSecurityLevel(@Nullable SecurityLevel securityLevel)	Specify security level of information in message.

Methods inherited from class java.lang.Object

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

Field Details

message

@NotNull
protected final @NotNull I18nMessage message

contextInfo

@NotNull
protected final @NotNull List<ContextInfo> contextInfo

helpUri

@Nullable
protected @Nullable URI helpUri

messageType

@NotNull
protected @NotNull MessageType messageType

securityLevel

@Nullable
protected @Nullable SecurityLevel securityLevel

Constructor Details

ProcessingMessageAbstractBuilder

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

ProcessingMessageAbstractBuilder

public ProcessingMessageAbstractBuilder(@NotNull
 @NotNull I18nMessage message)

ProcessingMessageAbstractBuilder

public ProcessingMessageAbstractBuilder(@NotNull
 @NotNull ProcessingMessage processingMessage)

Method Details

addContextInfo

@NotNull
public T 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<T extends ProcessingMessageBuilderMethods<T>>

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

Description copied from interface: ProcessingMessageBuilderMethods

Add contextual information to the message.

Specified by:

addContextInfo in interface ProcessingMessageBuilderMethods<T extends ProcessingMessageBuilderMethods<T>>

Parameters:

contextInfo - Additional contextual information appended to message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public T 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<T extends ProcessingMessageBuilderMethods<T>>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public T 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<T extends ProcessingMessageBuilderMethods<T>>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withSecurityLevel

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

Description copied from interface: ProcessingMessageBuilderMethods

Specify security level of information in message.

Specified by:

withSecurityLevel in interface ProcessingMessageBuilderMethods<T extends ProcessingMessageBuilderMethods<T>>

Parameters:

securityLevel - Security level of information in message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withMessageType

@NotNull
public T withMessageType(@NotNull
 @NotNull 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<T extends ProcessingMessageBuilderMethods<T>>

Parameters:

messageType - The type of this message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object