com.helger.commons.error

Class ResourceErrorGroup

java.lang.Object

com.helger.commons.error.ResourceErrorGroup

All Implemented Interfaces:

ICommonsIterable<IResourceError>, IHasErrorLevels, IResourceErrorGroup, ICloneable<ResourceErrorGroup>, IHasSize, IClearable, Serializable, Iterable<IResourceError>

@NotThreadSafe
public class ResourceErrorGroup
extends Object
implements IResourceErrorGroup, ICloneable<ResourceErrorGroup>, IClearable

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceErrorGroup()
ResourceErrorGroup(IResourceError... aResourceErrors)
ResourceErrorGroup(IResourceError aResourceError)
ResourceErrorGroup(Iterable<? extends IResourceError> aResourceErrors)

Method Summary

Modifier and Type	Method and Description
ResourceErrorGroup	addResourceError(IResourceError aResourceError) Add a new resource error item.
ResourceErrorGroup	addResourceErrorGroup(IResourceErrorGroup aResourceErrorGroup) Add a all resource errors of the other group
ResourceErrorGroup	addResourceErrors(IResourceError... aResourceErrors) Add multiple resource error items.
ResourceErrorGroup	addResourceErrors(Iterable<? extends IResourceError> aResourceErrors) Add multiple resource error items.
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	equals(Object o)
ICommonsList<IResourceError>	getAllResourceErrors() Get a list of all contained resource errors.
ResourceErrorGroup	getClone()
int	getErrorCount()
int	getFailureCount()
int	getSize()
int	getSuccessCount()
int	hashCode()
boolean	isEmpty()
Iterator<IResourceError>	iterator()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

containsAtLeastOneError, containsAtLeastOneFailure, containsAtLeastOneSuccess, containsNoError, containsNoFailure, containsNoSuccess, containsOnlyError, containsOnlyFailure, containsOnlySuccess, forEachResourceError, getAllErrors, getAllFailures, getMostSevereErrorLevel

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

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, spliterator

Constructor Detail

ResourceErrorGroup

public ResourceErrorGroup()

ResourceErrorGroup

public ResourceErrorGroup(@Nonnull
                          IResourceError aResourceError)

ResourceErrorGroup

public ResourceErrorGroup(@Nonnull
                          IResourceError... aResourceErrors)

ResourceErrorGroup

public ResourceErrorGroup(@Nonnull
                          Iterable<? extends IResourceError> aResourceErrors)

Method Detail

addResourceError

@Nonnull
public final ResourceErrorGroup addResourceError(@Nonnull
                                                           IResourceError aResourceError)

Add a new resource error item.

Parameters:

aResourceError - The resource error to be added. May not be null.

Returns:

this

addResourceErrors

@Nonnull
public ResourceErrorGroup addResourceErrors(@Nonnull
                                                      IResourceError... aResourceErrors)

Add multiple resource error items.

Parameters:

aResourceErrors - The resource errors to be added. May not be null.

Returns:

this

Since:

5.3.0

addResourceErrors

@Nonnull
public ResourceErrorGroup addResourceErrors(@Nonnull
                                                      Iterable<? extends IResourceError> aResourceErrors)

Add multiple resource error items.

Parameters:

aResourceErrors - The resource errors to be added. May not be null.

Returns:

this

Since:

5.3.0

addResourceErrorGroup

@Nonnull
public final ResourceErrorGroup addResourceErrorGroup(@Nonnull
                                                                IResourceErrorGroup aResourceErrorGroup)

Add a all resource errors of the other group

Parameters:

aResourceErrorGroup - The resource error group to be added. May not be null.

Returns:

this

getSuccessCount

@Nonnegative
public int getSuccessCount()

Specified by:

getSuccessCount in interface IHasErrorLevels

Returns:

The number of contained success messages. Always ≥ 0.

getFailureCount

@Nonnegative
public int getFailureCount()

Specified by:

getFailureCount in interface IHasErrorLevels

Returns:

The number of contained failure messages. Always ≥ 0.

getErrorCount

@Nonnegative
public int getErrorCount()

Specified by:

getErrorCount in interface IHasErrorLevels

Returns:

The number of contained error messages. Always ≥ 0. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

getSize

@Nonnegative
public int getSize()

Specified by:

getSize in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.getSize(), IHasSize.isNotEmpty()

getClone

@Nonnull
 @ReturnsMutableCopy
public ResourceErrorGroup getClone()

Specified by:

getClone in interface ICloneable<ResourceErrorGroup>

Returns:

A 100% deep-copy of the implementing class.

iterator

@Nonnull
public Iterator<IResourceError> iterator()

Specified by:

iterator in interface Iterable<IResourceError>

getAllResourceErrors

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<IResourceError> getAllResourceErrors()

Description copied from interface: IResourceErrorGroup

Get a list of all contained resource errors.

Specified by:

getAllResourceErrors in interface IResourceErrorGroup

Returns:

A non-null list of all contained error objects

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object