Module church.i18n.processing.exception

Package church.i18n.processing.message

Class ProcessingMessage

java.lang.Object

church.i18n.processing.message.ProcessingMessage

All Implemented Interfaces:

Serializable

public class ProcessingMessage
extends Object
implements Serializable

A generic definition of a processing message that carries information processing. A typical usage is during a processing error; however it's not bounded only to this type.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessingMessage(@NotNull I18nMessage message)	The constructor with the message.
ProcessingMessage(@NotNull I18nMessage message, @Nullable URI helpUri, @NotNull MessageType messageType, @NotNull List<ContextInfo> contextInfo, @Nullable SecurityLevel securityLevel)
ProcessingMessage(@NotNull String code, @Nullable Object... params)	Constructor of a processing message

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull List<ContextInfo>	getContextInfo()
@Nullable URI	getHelpUri()
@NotNull I18nMessage	getMessage()
@NotNull MessageType	getMessageType()
@Nullable SecurityLevel	getSecurityLevel()
int	hashCode()
@NotNull String	toString()
static @NotNull ProcessingMessageBuilder<ProcessingMessage>	withMessage(@NotNull I18nMessage message)	Create a builder of ProcessingMessage with specified I18nMessage message.
static @NotNull ProcessingMessageBuilder<ProcessingMessage>	withMessage(@NotNull ProcessingMessage message)	Copy constructor for the ProcessingMessage object.
static @NotNull ProcessingMessageBuilder<ProcessingMessage>	withMessage(@NotNull String code, @Nullable Object... params)	Create a builder of ProcessingMessage with specified message code and parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessingMessage

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

Constructor of a processing message

Parameters:

code - The code reference in the localization property file.

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

ProcessingMessage

public ProcessingMessage(@NotNull
 @NotNull I18nMessage message)

The constructor with the message. The message is required. As a MessageType the value of DefaultMessageType.DEFAULT is used.

Parameters:

message - Raw response message that is not formatted yet.

ProcessingMessage

public ProcessingMessage(@NotNull
 @NotNull I18nMessage message,
 @Nullable
 @Nullable URI helpUri,
 @NotNull
 @NotNull MessageType messageType,
 @NotNull
 @NotNull List<ContextInfo> contextInfo,
 @Nullable
 @Nullable SecurityLevel securityLevel)

Method Details

withMessage

@NotNull
public static @NotNull ProcessingMessageBuilder<ProcessingMessage> withMessage(@NotNull
 @NotNull String code,
 @Nullable
 @Nullable Object... params)

Create a builder of ProcessingMessage with specified message code and parameters.

Parameters:

code - The code reference in the localization property file.

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

Returns:

Builder of the ProcessingMessage object.

withMessage

@NotNull
public static @NotNull ProcessingMessageBuilder<ProcessingMessage> withMessage(@NotNull
 @NotNull I18nMessage message)

Create a builder of ProcessingMessage with specified I18nMessage message.

Parameters:

message - Raw response message that is not formatted yet.

Returns:

Builder of the ProcessingMessage object.

withMessage

@NotNull
public static @NotNull ProcessingMessageBuilder<ProcessingMessage> withMessage(@NotNull
 @NotNull ProcessingMessage message)

Copy constructor for the ProcessingMessage object.

Parameters:

message - Response message you would like to make a copy of.

Returns:

Builder of the ProcessingMessage object.

getContextInfo

@NotNull
public @NotNull List<ContextInfo> getContextInfo()

getHelpUri

@Nullable
public @Nullable URI getHelpUri()

getMessage

@NotNull
public @NotNull I18nMessage getMessage()

getMessageType

@NotNull
public @NotNull MessageType getMessageType()

getSecurityLevel

@Nullable
public @Nullable SecurityLevel getSecurityLevel()

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