Package com.exasol.errorreporting

Class ErrorMessageBuilder

java.lang.Object

com.exasol.errorreporting.ErrorMessageBuilder

public class ErrorMessageBuilder
extends Object

Builder for Exasol error messages.

Method Summary

Modifier and Type	Method	Description
ErrorMessageBuilder	message(String message)	Add exception message.
ErrorMessageBuilder	mitigation(String mitigation)	Add a mitigation.
ErrorMessageBuilder	parameter(String placeholder, Object value)	Add a parameter.
ErrorMessageBuilder	parameter(String placeholder, Object value, String description)	Add a parameter.
ErrorMessageBuilder	ticketMitigation()	Add a mitigation for cases in which the only thing a user can do is opening a ticket.
String	toString()	Build the error message.
ErrorMessageBuilder	unquotedParameter(String placeholder, Object value)	Add a parameter without quotes.
ErrorMessageBuilder	unquotedParameter(String placeholder, Object value, String description)	Add a parameter without quotes.

Methods inherited from class java.lang.Object

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

Method Detail

message

public ErrorMessageBuilder message(String message)

Add exception message.

If this method is called multiple times, the message is appended.

Parameters:

message - exception message

Returns:

self for fluent programming

parameter

public ErrorMessageBuilder parameter(String placeholder,
                                     Object value)

Add a parameter. This method quotes the parameter.

You can use the parameter in message and mitigation using {{parameter}}.

Parameters:

placeholder - placeholder without parentheses

value - value to insert

Returns:

self for fluent programming

parameter

public ErrorMessageBuilder parameter(String placeholder,
                                     Object value,
                                     String description)

Add a parameter. This method quotes the parameter.

You can use the parameter in message and mitigation using {{parameter}}.

Parameters:

placeholder - placeholder without parentheses

value - value to insert

description - description for the error catalog

Returns:

self for fluent programming

unquotedParameter

public ErrorMessageBuilder unquotedParameter(String placeholder,
                                             Object value)

Add a parameter without quotes.

Parameters:

placeholder - placeholder without parentheses

value - value to insert

Returns:

self for fluent programming

unquotedParameter

public ErrorMessageBuilder unquotedParameter(String placeholder,
                                             Object value,
                                             String description)

Add a parameter without quotes.

Parameters:

placeholder - placeholder without parentheses

value - value to insert

description - description for the error catalog

Returns:

self for fluent programming

mitigation

public ErrorMessageBuilder mitigation(String mitigation)

Add a mitigation. Explain here what users can do to resolve or avoid this error.

Parameters:

mitigation - explanation

Returns:

self for fluent programming

ticketMitigation

public ErrorMessageBuilder ticketMitigation()

Add a mitigation for cases in which the only thing a user can do is opening a ticket.

Returns:

self for fluent programming

toString

public String toString()

Build the error message.

Overrides:

toString in class Object

Returns:

built error massage string