de.vandermeer.skb.interfaces.messagesets

Interface IsWarningSet<M>

All Superinterfaces:

CategoryDoes, CategoryIs, DoesRender, IsMessageSet

All Known Subinterfaces:

HeadsSuccessWithInfoAndWarnings<R,M>, HeadsSuccessWithWarnings<R,M>, IsWarningSetFT

public interface IsWarningSet<M>
extends IsMessageSet

Interface for objects that have a set of warning messages.

Since:

v0.0.1

Version:

v0.0.2 build 170502 (02-May-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(Collection<M> warnings) Adds all warnings from given collection.
default void	addWarning(M warning) Adds a new warning.
default void	clearWarningMessages() Clears all warnings.
static <M> IsWarningSet<M>	create() Creates a new warning set.
Set<M>	getWarningMessages() Returns the warning set.
default boolean	hasWarnings() Tests if warnings have been added.
default boolean	isErrorSet() Tests if the message set is an error set.
default boolean	isWarningSet() Tests if the message set is an warning set.
default String	render() Renders the warning set.

Methods inherited from interface IsMessageSet

isInfoSet

Method Detail

isErrorSet

default boolean isErrorSet()

Description copied from interface: IsMessageSet

Tests if the message set is an error set.

Specified by:

isErrorSet in interface IsMessageSet

Returns:

true if error set, false otherwise

isWarningSet

default boolean isWarningSet()

Description copied from interface: IsMessageSet

Tests if the message set is an warning set.

Specified by:

isWarningSet in interface IsMessageSet

Returns:

true if warning set, false otherwise

clearWarningMessages

default void clearWarningMessages()

Clears all warnings.

getWarningMessages

Set<M> getWarningMessages()

Returns the warning set.

Returns:

warning set, should not be null

addWarning

default void addWarning(M warning)

Adds a new warning.

Parameters:

warning - warning to add

addAllWarnings

default void addAllWarnings(Collection<M> warnings)

Adds all warnings from given collection.

Parameters:

warnings - collection of warnings to add

hasWarnings

default boolean hasWarnings()

Tests if warnings have been added.

Returns:

true if warnings are in the set, false otherwise

render

default String render()

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

Specified by:

render in interface DoesRender

Returns:

rendered object

create

static <M> IsWarningSet<M> create()

Creates a new warning set.

Type Parameters:

M - type of the messages in the set

Returns:

new warning set