de.vandermeer.skb.interfaces

Interface FormattingTupleWrapper

public interface FormattingTupleWrapper

Wraps a formatting tuple object from SLF4J simplifying messages.

Since:

v0.0.1

Version:

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

Author:

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

Method Summary

Modifier and Type	Method and Description
static FormattingTupleWrapper	create(String msg) Creates a new wrapper.
static FormattingTupleWrapper	create(String msg, Object... obj) Creates a new wrapper.
default String	getMessage() Returns the formatted (rendered) message using the set formatting tuple.
FormattingTuple	getTuple() Returns the set formatting tuple.

Method Detail

getTuple

FormattingTuple getTuple()

Returns the set formatting tuple.

Returns:

formatting tuple

getMessage

default String getMessage()

Returns the formatted (rendered) message using the set formatting tuple.

Returns:

formatted (rendered) message

create

static FormattingTupleWrapper create(String msg)

Creates a new wrapper.

Parameters:

msg - the message for the wrapper, should not be blank

Returns:

new wrapper with given message

Throws:

NullPointerException - if msg was null

IllegalArgumentException - if msg was blank

create

static FormattingTupleWrapper create(String msg,
                                     Object... obj)

Creates a new wrapper.

Parameters:

msg - the message for the wrapper, should not be blank

obj - the elements for the message, should not be null and have no null elements

Returns:

new wrapper with given message

Throws:

NullPointerException - if msg or obj was null

IllegalArgumentException - if msg was blank or obj contained null elements