de.vandermeer.skb.base.managers

Class MessageRenderer

Object

MessageRenderer

public class MessageRenderer
extends Object

Renderer for a Message5WH object.

Since:

v0.1.2

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
static STGroup	DEFAULT_STG The default STGroup for messages read from DEFAULT_STG_FN.
static String	DEFAULT_STG_FN The file name of the default STGroup file.
protected STGroup	stg The ST group for the message
static Map<String,Set<String>>	STG_CHUNKS The STGroup chunks for validation of an STGroup for a message.

Constructor Summary

Constructors

Constructor and Description
MessageRenderer() Returns a new renderer with the default STGroup.
MessageRenderer(STGroup stg) Returns a new renderer with the given STGroup.
MessageRenderer(String filename) Returns a new renderer with the STGroup read from the given file name (file system or as resource).

Method Summary

Modifier and Type	Method and Description
String	render(Collection<Message5WH> messages) Renders a collection of messages.
String	render(Message5WH msg) Renders a single message
protected void	validateSTG() Validates the local STGroup

Methods inherited from class Object

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

Field Detail

stg

protected STGroup stg

The ST group for the message

DEFAULT_STG_FN

public static String DEFAULT_STG_FN

The file name of the default STGroup file.

DEFAULT_STG

public static STGroup DEFAULT_STG

The default STGroup for messages read from DEFAULT_STG_FN.

STG_CHUNKS

public static final Map<String,Set<String>> STG_CHUNKS

The STGroup chunks for validation of an STGroup for a message.

Constructor Detail

MessageRenderer

public MessageRenderer()

Returns a new renderer with the default STGroup.

MessageRenderer

public MessageRenderer(STGroup stg)

Returns a new renderer with the given STGroup.

Parameters:

stg - given STGroup for the renderer

Throws:

IllegalArgumentException - if the given STGroup was null or not valid

MessageRenderer

public MessageRenderer(String filename)

Returns a new renderer with the STGroup read from the given file name (file system or as resource).

Parameters:

filename - file to read STGroup from

Throws:

IllegalArgumentException - if the given file name or STGroup was null or not valid

Method Detail

validateSTG

protected void validateSTG()

Validates the local STGroup

Throws:

IllegalArgumentException - if the local STGroup was null or not valid

render

public String render(Message5WH msg)

Renders a single message

Parameters:

msg - message to render

Returns:

string with the rendered message, empty if parameter was null

render

public String render(Collection<Message5WH> messages)

Renders a collection of messages.

Parameters:

messages - the collection of messages to render

Returns:

string with rendered messages