de.vandermeer.skb.interfaces.messagesets

Interface IsErrorSet<M>

All Superinterfaces:

CategoryDoes, CategoryIs, DoesRender, IsMessageSet

All Known Subinterfaces:

IsErrorSetFT, TailsErrorWithErrors<R,M>, TailsNullWithErrors<M>

public interface IsErrorSet<M>
extends IsMessageSet

Interface for objects that have a set of error 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	addAllErrors(Collection<M> errors) Adds all errors from given collection.
default void	addError(M error) Adds a new error.
default void	clearErrorMessages() Clears all errors.
static <M> IsErrorSet<M>	create() Creates a new error set.
Set<M>	getErrorMessages() Returns the error set.
default boolean	hasErrors() Tests if errors have been added.
default String	render() Renders the error set.

Methods inherited from interface IsMessageSet

isErrorSet, isInfoSet, isWarningSet

Method Detail

clearErrorMessages

default void clearErrorMessages()

Clears all errors.

getErrorMessages

Set<M> getErrorMessages()

Returns the error set.

Returns:

error set, should not be null

addError

default void addError(M error)

Adds a new error.

Parameters:

error - error to add

addAllErrors

default void addAllErrors(Collection<M> errors)

Adds all errors from given collection.

Parameters:

errors - collection of errors to add

hasErrors

default boolean hasErrors()

Tests if errors have been added.

Returns:

true if errors are in the set, false otherwise

render

default String render()

Renders the error set. The method uses DoesRender or simple toString to render errors. Each element in the error set is rendered in a single line.

Specified by:

render in interface DoesRender

Returns:

rendered object

create

static <M> IsErrorSet<M> create()

Creates a new error set.

Type Parameters:

M - type of the messages in the set

Returns:

new error set