de.vandermeer.skb.interfaces.messagesets

Interface IsInfoSet<M>

All Superinterfaces:

CategoryDoes, CategoryIs, DoesRender, IsMessageSet

All Known Subinterfaces:

HeadsSuccessWithInfo<R,M>, HeadsSuccessWithInfoAndWarnings<R,M>, IsInfoSetFT

public interface IsInfoSet<M>
extends IsMessageSet

Interface for objects that have a set of info 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	addAllInfos(Collection<M> infos) Adds all infos from given collection.
default void	addInfo(M info) Adds a new info.
default void	clearInfoMessages() Clears all infos.
static <M> IsInfoSet<M>	create() Creates a new info set.
Set<M>	getInfoMessages() Returns the info set.
default boolean	hasInformation() Tests if infos have been added.
default boolean	isInfoSet() Tests if the message set is an info set.
default String	render() Renders the info set.

Methods inherited from interface IsMessageSet

isErrorSet, isWarningSet

Method Detail

isInfoSet

default boolean isInfoSet()

Description copied from interface: IsMessageSet

Tests if the message set is an info set.

Specified by:

isInfoSet in interface IsMessageSet

Returns:

true if info set, false otherwise

clearInfoMessages

default void clearInfoMessages()

Clears all infos.

getInfoMessages

Set<M> getInfoMessages()

Returns the info set.

Returns:

info set, should not be null

addInfo

default void addInfo(M info)

Adds a new info.

Parameters:

info - info to add

addAllInfos

default void addAllInfos(Collection<M> infos)

Adds all infos from given collection.

Parameters:

infos - collection of information to add

hasInformation

default boolean hasInformation()

Tests if infos have been added.

Returns:

true if infos are in the set, false otherwise

render

default String render()

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

Specified by:

render in interface DoesRender

Returns:

rendered object

create

static <M> IsInfoSet<M> create()

Creates a new info set.

Type Parameters:

M - type of the messages in the set

Returns:

new info set