Package com.exsol.errorcodemodel

Class ErrorMessageDeclaration.Builder

java.lang.Object

com.exsol.errorcodemodel.ErrorMessageDeclaration.Builder

Enclosing class:

ErrorMessageDeclaration

public static class ErrorMessageDeclaration.Builder
extends Object

Builder for ErrorMessageDeclaration.

Method Summary

Modifier and Type	Method	Description
ErrorMessageDeclaration.Builder	addParameter(String name, String description)	Add a parameter.
ErrorMessageDeclaration.Builder	appendMitigation(String mitigation)	Append a mitigation.
ErrorMessageDeclaration	build()	Build the ErrorMessageDeclaration.
ErrorMessageDeclaration.Builder	declaringPackage(String declaringPackage)	Set the declaring java-package.
ErrorMessageDeclaration.Builder	identifier(String identifier)	Set the error identifier.
ErrorMessageDeclaration.Builder	prependMessage(String message)	Prepend a message part.
ErrorMessageDeclaration.Builder	prependMitigation(String mitigation)	Prepend a mitigation.
ErrorMessageDeclaration.Builder	setPosition(String sourceFile, int line)	Set the position where the error message is declared.

Methods inherited from class java.lang.Object

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

Method Detail

identifier

public ErrorMessageDeclaration.Builder identifier(String identifier)

Set the error identifier.

Parameters:

identifier - error identifier

Returns:

self for fluent programming

setPosition

public ErrorMessageDeclaration.Builder setPosition(String sourceFile,
                                                   int line)

Set the position where the error message is declared.

Parameters:

sourceFile - name of the source file relative to the project's root directory

line - line number

Returns:

self for fluent programming

declaringPackage

public ErrorMessageDeclaration.Builder declaringPackage(String declaringPackage)

Set the declaring java-package.

Parameters:

declaringPackage - declaring java package

Returns:

self for fluent programming

prependMessage

public ErrorMessageDeclaration.Builder prependMessage(String message)

Prepend a message part.

Parameters:

message - message to prepend.

Returns:

self for fluent programming

prependMitigation

public ErrorMessageDeclaration.Builder prependMitigation(String mitigation)

Prepend a mitigation.

Parameters:

mitigation - mitigation to prepend.

Returns:

self for fluent programming

appendMitigation

public ErrorMessageDeclaration.Builder appendMitigation(String mitigation)

Append a mitigation.

Parameters:

mitigation - mitigation to prepend.

Returns:

self for fluent programming

addParameter

public ErrorMessageDeclaration.Builder addParameter(String name,
                                                    String description)

Add a parameter.

Parameters:

name - parameter name

description - description

Returns:

self for fluent programming

build

public ErrorMessageDeclaration build()

Build the ErrorMessageDeclaration.

Returns:

built ErrorMessageDeclaration