de.vandermeer.skb.interfaces.messagesets

Interface IsWarningSetFT

All Superinterfaces:

CategoryDoes, CategoryIs, DoesRender, IsMessageSet, IsWarningSet<FormattingTuple>

public interface IsWarningSetFT
extends IsWarningSet<FormattingTuple>

Interface for objects that have a set of warning 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
default void	addAllWarnings(IsWarningSetFT warnings) Adds all warnings from given warning set.
default void	addError(String warning) Adds a new warning.
default void	addError(String warning, Object... obj) Adds a new warning.
static IsWarningSetFT	create() Creates a new warning set.
default String	render() Renders the warning set.

Methods inherited from interface IsWarningSet

addAllWarnings, addWarning, clearWarningMessages, getWarningMessages, hasWarnings, isErrorSet, isWarningSet

Methods inherited from interface IsMessageSet

isInfoSet

Method Detail

addAllWarnings

default void addAllWarnings(IsWarningSetFT warnings)

Adds all warnings from given warning set.

Parameters:

warnings - warnings to add

addError

default void addError(String warning)

Adds a new warning.

Parameters:

warning - the warning message, should not be blank

Throws:

NullPointerException - if warning was null

IllegalArgumentException - if warning was blank

addError

default void addError(String warning,
                      Object... obj)

Adds a new warning.

Parameters:

warning - the warning message, should not be blank

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

Throws:

NullPointerException - if warning or obj was null

IllegalArgumentException - if warning was blank or obj contained null elements

render

default String render()

Renders the warning set. Each element in the warning set is rendered in a single line.

Specified by:

render in interface DoesRender

Specified by:

render in interface IsWarningSet<FormattingTuple>

Returns:

rendered object

create

static IsWarningSetFT create()

Creates a new warning set.

Specified by:

create in interface IsWarningSet<FormattingTuple>

Returns:

new warning set