Module church.i18n.processing.exception

Package church.i18n.processing.exception

Class ProcessingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

church.i18n.processing.exception.ProcessingException

All Implemented Interfaces:

ProcessingExceptionIntermediate<ProcessingException>, ProcessingInfo, ProcessingStatus, ProcessingLogLevel, ProcessingMessageBuilderMethods<ProcessingException>, Serializable

public class ProcessingException
extends RuntimeException
implements ProcessingInfo, ProcessingExceptionIntermediate<ProcessingException>

Generic exception with enough information but not more for handling exceptional state in the application. It holds information user may need to know what has happened, how to deal with the problem or where to look for a solution.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessingException(@NotNull ProcessingMessage message)	Constructor with specified message.
ProcessingException(@NotNull ProcessingMessage message, @Nullable Throwable cause)	Constructor with a message and concrete cause of this exception.
ProcessingException(@NotNull String code, @Nullable Object... params)	Constructor with base code and message parameters.

Method Summary

Modifier and Type	Method	Description
@NotNull ProcessingException	addContextInfo(@Nullable ContextInfo... contextInfo)	Add contextual information to the message.
@NotNull ProcessingException	addContextInfo(@Nullable List<ContextInfo> contextInfo)	Add additional contextual information bounded to message.
boolean	equals(Object obj)
@NotNull LogLevel	getLogLevel()	Specification of a logging level of an error.
@NotNull ProcessingMessage	getProcessingMessage()
@NotNull Status	getStatus()	The value describes wider status of processing and can be used for inter-system communication.
int	hashCode()
@NotNull String	toString()
@NotNull ProcessingException	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 ProcessingException	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 ProcessingException	withLogLevel(@NotNull LogLevel logLevel)	Specify log level of exception.
@NotNull ProcessingException	withMessageType(@NotNull MessageType messageType)	Type of message, such as severity or message status.
@NotNull ProcessingException	withSecurityLevel(@Nullable SecurityLevel securityLevel)	Specify security level of information in message.
@NotNull ProcessingException	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.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessingException

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

Constructor with base code and message parameters.

Parameters:

code - The code that may reference message in localization property file. When no such localized message with code has been found, the code itself is used as message.

params - list of parameters needed for construction of localized message. If the last parameter is Throwable, it is used as cause of this exception.

ProcessingException

public ProcessingException(@NotNull
 @NotNull ProcessingMessage message)

Constructor with specified message.

Parameters:

message - Error message of the exception.

ProcessingException

public ProcessingException(@NotNull
 @NotNull ProcessingMessage message,
 @Nullable
 @Nullable Throwable cause)

Constructor with a message and concrete cause of this exception.

Parameters:

message - A message of the exception.

cause - The throwable that caused this ProcessingException to get thrown.

Method Details

addContextInfo

@NotNull
public @NotNull ProcessingException 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<ProcessingException>

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

Description copied from interface: ProcessingMessageBuilderMethods

Add contextual information to the message.

Specified by:

addContextInfo in interface ProcessingMessageBuilderMethods<ProcessingException>

Parameters:

contextInfo - Additional contextual information appended to message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingException 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<ProcessingException>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withHelpUri

@NotNull
public @NotNull ProcessingException 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<ProcessingException>

Parameters:

helpUri - Resource identifier.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withSecurityLevel

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

Description copied from interface: ProcessingMessageBuilderMethods

Specify security level of information in message.

Specified by:

withSecurityLevel in interface ProcessingMessageBuilderMethods<ProcessingException>

Parameters:

securityLevel - Security level of information in message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

withMessageType

@NotNull
public @NotNull ProcessingException 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<ProcessingException>

Parameters:

messageType - The type of this message.

Returns:

An instance of an ProcessingMessageBuilderMethods with appended contextual information.

getLogLevel

@NotNull
public @NotNull LogLevel getLogLevel()

Description copied from interface: ProcessingLogLevel

Specification of a logging level of an error.

Specified by:

getLogLevel in interface ProcessingLogLevel

Returns:

Log level of exception.

getProcessingMessage

@NotNull
public @NotNull ProcessingMessage getProcessingMessage()

Specified by:

getProcessingMessage in interface ProcessingInfo

getStatus

@NotNull
public @NotNull Status getStatus()

Description copied from interface: ProcessingStatus

The value describes wider status of processing and can be used for inter-system communication. The typical example usage can be similar to widely known HTTP response status.

Specified by:

getStatus in interface ProcessingStatus

Returns:

Status associated with the exception.

withLogLevel

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

Description copied from interface: ProcessingExceptionIntermediate

Specify log level of exception.

Specified by:

withLogLevel in interface ProcessingExceptionIntermediate<ProcessingException>

Parameters:

logLevel - The log level you want to use.

Returns:

An instance of object ProcessingExceptionIntermediate.

withStatus

@NotNull
public @NotNull ProcessingException 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<ProcessingException>

Parameters:

status - Status associated with this exception.

Returns:

An instance of object ProcessingExceptionIntermediate.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Throwable