de.vandermeer.skb.base.message

Class Message5WH

Object

Message5WH

All Implemented Interfaces:

CategoryDoes, CategoryHas, HasToStringStyle, DoesRender

public class Message5WH
extends Object
implements DoesRender, HasToStringStyle

Standard SKB message.

Since:

v0.0.1

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 int	whereColumn Where did it happen: column.
protected int	whereLine Where did it happen: line.
protected Object	whereLocation Where did it happen: location.

Method Summary

Modifier and Type	Method and Description
Message5WH	changeType(E_MessageType type) Changes the type of the message.
StrBuilder	getHow() Returns the How? part of the message.
Object	getReporter() Returns the reporter of the message
E_MessageType	getType() Returns the type of the message.
StrBuilder	getWhat() Returns the What? part of the message.
Object	getWhen() Returns the When? part of the message.
int	getWhereColumn() Returns the Where? column part of the message.
int	getWhereLine() Returns the Where? line part of the message.
Object	getWhereLocation() Returns the Where? location part of the message.
Object	getWho() Returns the Who? part of the message.
StrBuilder	getWhy() Returns the Why? part of the message.
String	render()
boolean	setReporter(Object reporter) Sets the reporter.
String	toString() Returns a string representation of the message for debugging purpose, but not the rendered output.

Methods inherited from class Object

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

Methods inherited from interface HasToStringStyle

getStyle, getStyle

Field Detail

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.

Method Detail

render

public String render()

Specified by:

render in interface DoesRender

setReporter

public boolean setReporter(Object reporter)

Sets the reporter.

Parameters:

reporter - new reporter

Returns:

true on success (reporter was not null), false otherwise

getHow

public StrBuilder getHow()

Returns the How? part of the message.

Returns:

How? part, null if no set

getReporter

public Object getReporter()

Returns the reporter of the message

Returns:

message reporter, null if not set

getType

public E_MessageType getType()

Returns the type of the message.

Returns:

message type, null if not set

getWhat

public StrBuilder getWhat()

Returns the What? part of the message.

Returns:

What? part, null if no set

getWhen

public Object getWhen()

Returns the When? part of the message.

Returns:

When? part, null if no set

getWhereLocation

public Object getWhereLocation()

Returns the Where? location part of the message.

Returns:

Where? location part, null if no set

getWhereLine

public int getWhereLine()

Returns the Where? line part of the message.

Returns:

Where? line part, 0 if no set

getWhereColumn

public int getWhereColumn()

Returns the Where? column part of the message.

Returns:

Where? column part, null if no set

getWho

public Object getWho()

Returns the Who? part of the message.

Returns:

Who? part, null if no set

getWhy

public StrBuilder getWhy()

Returns the Why? part of the message.

Returns:

Why? part, null if no set

changeType

public Message5WH changeType(E_MessageType type)

Changes 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

toString

public String toString()

Returns a string representation of the message for debugging purpose, but not the rendered output. To render the message, i.e. to get the message as a text for logging or console output, please use render().

Overrides:

toString in class Object

Returns:

(debug) string representation of the message