com.helger.commons.error

Interface IResourceErrorGroup

All Superinterfaces:

ICommonsIterable<IResourceError>, IHasErrorLevels, IHasSize, Iterable<IResourceError>, Serializable

All Known Implementing Classes:

ResourceErrorGroup

public interface IResourceErrorGroup
extends IHasSize, ICommonsIterable<IResourceError>, IHasErrorLevels, Serializable

Contains a list of resource errors and some sanity access methods.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default boolean	containsAtLeastOneError() Check if this group contains at least one error or fatal error message.
default boolean	containsAtLeastOneFailure() Check if this group contains at least one failure message.
default boolean	containsAtLeastOneSuccess() Check if this group contains at least one success message.
default boolean	containsNoError() Check if this group contains no error or fatal error message.
default boolean	containsNoFailure() Check if this group contains no failure message.
default boolean	containsNoSuccess() Check if this group contains no success message.
default boolean	containsOnlyError() Check if this group contains only error or fatal error messages.
default boolean	containsOnlyFailure() Check if this group contains only failure messages.
default boolean	containsOnlySuccess() Check if this group contains only success messages.
default void	forEachResourceError(Consumer<? super IResourceError> aConsumer) Deprecated.
default IResourceErrorGroup	getAllErrors() Get a resource error group containing only the error elements.
default IResourceErrorGroup	getAllFailures() Get a resource error group containing only the failure elements.
ICommonsList<IResourceError>	getAllResourceErrors() Get a list of all contained resource errors.
default IErrorLevel	getMostSevereErrorLevel() Get the most severe error level within this object.

Methods inherited from interface com.helger.commons.lang.IHasSize

getSize, isEmpty, isNotEmpty

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEachBreakable

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.helger.commons.error.IHasErrorLevels

getErrorCount, getFailureCount, getSuccessCount

Method Detail

getMostSevereErrorLevel

@Nonnull
default IErrorLevel getMostSevereErrorLevel()

Description copied from interface: IHasErrorLevels

Get the most severe error level within this object. The severity is defined by EErrorLevel's severity model.

Specified by:

getMostSevereErrorLevel in interface IHasErrorLevels

Returns:

EErrorLevel.SUCCESS if no resource error is contained, the most severe contained error level otherwise.

containsOnlySuccess

default boolean containsOnlySuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains only success messages. If no item is present, false is returned, since no success message is contained. If you want to check, if the list is empty or contains only success messages, use IHasErrorLevels.containsNoFailure() instead.

Specified by:

containsOnlySuccess in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have the error level success, false otherwise.

See Also:

IHasErrorLevels.containsNoFailure()

containsAtLeastOneSuccess

default boolean containsAtLeastOneSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one success message.

Specified by:

containsAtLeastOneSuccess in interface IHasErrorLevels

Returns:

true if at least one success item is present, false otherwise.

containsNoSuccess

default boolean containsNoSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains no success message. This is also true, if the list is empty!

Specified by:

containsNoSuccess in interface IHasErrorLevels

Returns:

true if no success item is present, false otherwise.

containsOnlyFailure

default boolean containsOnlyFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains only failure messages. If no item is present, false is returned. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsOnlyFailure in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating failure, false otherwise.

containsAtLeastOneFailure

default boolean containsAtLeastOneFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsAtLeastOneFailure in interface IHasErrorLevels

Returns:

true if at least one failure item is present, false otherwise.

containsNoFailure

default boolean containsNoFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains no failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsNoFailure in interface IHasErrorLevels

Returns:

true if no failure item is present, false otherwise.

containsOnlyError

default boolean containsOnlyError()

Description copied from interface: IHasErrorLevels

Check if this group contains only error or fatal error messages. If no item is present, false is returned. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsOnlyError in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating error or fatal error, false otherwise.

containsAtLeastOneError

default boolean containsAtLeastOneError()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsAtLeastOneError in interface IHasErrorLevels

Returns:

true if at least one error or fatal error item is present, false otherwise.

containsNoError

default boolean containsNoError()

Description copied from interface: IHasErrorLevels

Check if this group contains no error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsNoError in interface IHasErrorLevels

Returns:

true if no error or fatal error item is present, false otherwise.

getAllFailures

@Nonnull
default IResourceErrorGroup getAllFailures()

Get a resource error group containing only the failure elements. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Returns:

A resource error group containing only the failures.

getAllErrors

@Nonnull
default IResourceErrorGroup getAllErrors()

Get a resource error group containing only the error elements. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Returns:

A resource error group containing only the errors.

getAllResourceErrors

@Nonnull
 @ReturnsMutableCopy
ICommonsList<IResourceError> getAllResourceErrors()

Get a list of all contained resource errors.

Returns:

A non-null list of all contained error objects

forEachResourceError

@Deprecated
default void forEachResourceError(@Nonnull
                                               Consumer<? super IResourceError> aConsumer)

Deprecated.

Call the provided consumer for all contained resource errors.

Parameters:

aConsumer - The consumer to be invoked. May not be null. May only perform reading actions!