de.vandermeer.skb.base.message

Class Message5WH_Builder

Object

Message5WH_Builder

public class Message5WH_Builder
extends Object

Builder for a Message5WH object.

Since:

v0.0.7

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected StrBuilder	how How did it happen?
protected int	initialCapacity Initial capacity for StrBuilder members
protected Object	reporter Who reports it?
protected E_MessageType	type Type of message
protected StrBuilder	what What happened?
protected Object	when When did take place/happen?
protected int	whereColumn Where did it happen: column.
protected int	whereLine Where did it happen: line.
protected Object	whereLocation Where did it happen: location.
protected Object	who Who is this message about?
protected StrBuilder	why Why did it happen?

Constructor Summary

Constructors

Constructor and Description
Message5WH_Builder()

Method Summary

Modifier and Type	Method and Description
Message5WH_Builder	addHow(Object... how) Adds to the How? part of the message.
Message5WH_Builder	addWhat(Object... what) Adds to the What? part of the message.
Message5WH_Builder	addWhy(Object... why) Adds to the Why? part of the message.
Message5WH	build() Builds a message object with the set parameters.
Message5WH_Builder	setReporter(Object reporter) Sets the Reporter of the message.
Message5WH_Builder	setType(E_MessageType type) Sets the type of the message.
Message5WH_Builder	setWhen(Object when) Sets the When? part of the message.
Message5WH_Builder	setWhere(Object where) Sets the Where? part of the message.
Message5WH_Builder	setWhere(Object where, int line, int column) Sets the Where? part of the message.
Message5WH_Builder	setWhere(Object where, ParserRuleContext lineAndColumn) Sets the Where? part of the message.
Message5WH_Builder	setWhere(Object where, RecognitionException lineAndColumn) Sets the Where? part of the message.
Message5WH_Builder	setWhere(Object where, Token lineAndColumn) Sets the Where? part of the message.
Message5WH_Builder	setWhere(StackTraceElement ste) Sets the Where? part of the message.
Message5WH_Builder	setWho(Object who) Sets the Who? part of the message.

Methods inherited from class Object

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

Field Detail

initialCapacity

protected int initialCapacity

Initial capacity for StrBuilder members

who

protected Object who

Who is this message about?

what

protected StrBuilder what

What happened?

whereLocation

protected Object whereLocation

Where did it happen: location.

whereLine

protected int whereLine

Where did it happen: line.

whereColumn

protected int whereColumn

Where did it happen: column.

when

protected Object when

When did take place/happen?

why

protected StrBuilder why

Why did it happen?

how

protected StrBuilder how

How did it happen?

reporter

protected Object reporter

Who reports it?

type

protected E_MessageType type

Type of message

Constructor Detail

Message5WH_Builder

public Message5WH_Builder()

Method Detail

addHow

public Message5WH_Builder addHow(Object... how)

Adds to the How? part of the message. If the argument is null, no change will be done. Otherwise if nothing was set to How? yet, the given argument will be used as initial value. If not, then the argument will be appended as is w/o any implicit separators.

Parameters:

how - additional information for How?

Returns:

self to allow chaining

addWhat

public Message5WH_Builder addWhat(Object... what)

Adds to the What? part of the message. If the argument is null, no change will be done. Otherwise if nothing was set to What? yet, the given argument will be used as initial value. If not, then the argument will be appended as is w/o any implicit separators.

Parameters:

what - additional information for What?

Returns:

self to allow chaining

addWhy

public Message5WH_Builder addWhy(Object... why)

Adds to the Why? part of the message. If the argument is null, no change will be done. Otherwise if nothing was set to Why? yet, the given argument will be used as initial value. If not, then the argument will be appended as is w/o any implicit separators.

Parameters:

why - additional information for Why?

Returns:

self to allow chaining

setReporter

public Message5WH_Builder setReporter(Object reporter)

Sets the Reporter of the message. Since null is a valid value for this member of the message, no further check is applied to the argument.

Parameters:

reporter - new reporter

Returns:

self to allow chaining

setType

public Message5WH_Builder setType(E_MessageType type)

Sets the type of the message. Since null is a valid value for this member of the message, no further check is applied to the argument.

Parameters:

type - new type

Returns:

self to allow chaining

setWhen

public Message5WH_Builder setWhen(Object when)

Sets the When? part of the message. Since null is a valid value for this part of the message, no further check is applied to the argument.

Parameters:

when - new When? part

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(Object where,
                                   int line,
                                   int column)

Sets the Where? part of the message. Nothing will be set if the first parameter is null.

Parameters:

where - location for Where?

line - line for Where?, ignored if <1;

column - column for Where?, ignored if <1

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(Object where,
                                   RecognitionException lineAndColumn)

Sets the Where? part of the message. Line and column information are taken from the recognition exception, if they are larger than 0. Nothing will be set if the two parameters are null.

Parameters:

where - location for Where?

lineAndColumn - source for the Where? part

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(Object where)

Sets the Where? part of the message. Line and column information are set to 0.

Parameters:

where - location for Where?

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(Object where,
                                   Token lineAndColumn)

Sets the Where? part of the message. Line and column information are taken from the token, if they are larger than 0. Nothing will be set if the two parameters are null.

Parameters:

where - location for Where?

lineAndColumn - source for the Where? part

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(Object where,
                                   ParserRuleContext lineAndColumn)

Sets the Where? part of the message. Line and column information are taken from the tree, if they are larger than 0. Nothing will be set if the two parameters are null.

Parameters:

where - location for Where?

lineAndColumn - source for the Where? part

Returns:

self to allow chaining

setWhere

public Message5WH_Builder setWhere(StackTraceElement ste)

Sets the Where? part of the message. Three values are taken from the stack trace: class name and method name for the location of Where? and line number for the the line. If the stack trace is null or class name and method are empty, nothing will be set. A line number of 0 will be ignored.

Parameters:

ste - source for the Where? part

Returns:

self to allow chaining

setWho

public Message5WH_Builder setWho(Object who)

Sets the Who? part of the message. Since null is a valid value for this part of the message, no further check is applied to the argument.

Parameters:

who - new Who? part

Returns:

self to allow chaining

build

public Message5WH build()

Builds a message object with the set parameters.

Returns:

new message object