de.vandermeer.skb.interfaces.messagesets

Interface IsErrorSetFT

All Superinterfaces:

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

public interface IsErrorSetFT
extends IsErrorSet<FormattingTuple>

Interface for objects that have a set of error messages of type FormattingTuple.

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	addAllErrors(IsErrorSetFT errors) Adds all errors from given error set.
default void	addError(String error) Adds a new error.
default void	addError(String error, Object... obj) Adds a new error.
static IsErrorSetFT	create() Creates a new error set.
default String	render() Renders the error set.

Methods inherited from interface IsErrorSet

addAllErrors, addError, clearErrorMessages, getErrorMessages, hasErrors

Methods inherited from interface IsMessageSet

isErrorSet, isInfoSet, isWarningSet

Method Detail

addAllErrors

default void addAllErrors(IsErrorSetFT errors)

Adds all errors from given error set.

Parameters:

errors - errors to add

addError

default void addError(String error)

Adds a new error.

Parameters:

error - the error message, should not be blank

Throws:

NullPointerException - if error was null

IllegalArgumentException - if error was blank

addError

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

Adds a new error.

Parameters:

error - the error message, should not be blank

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

Throws:

NullPointerException - if error or obj was null

IllegalArgumentException - if error was blank or obj contained null elements

render

default String render()

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

Specified by:

render in interface DoesRender

Specified by:

render in interface IsErrorSet<FormattingTuple>

Returns:

rendered object

create

static IsErrorSetFT create()

Creates a new error set.

Specified by:

create in interface IsErrorSet<FormattingTuple>

Returns:

new error set