com.phloc.commons.error

Class ResourceErrorGroup

java.lang.Object

com.phloc.commons.error.ResourceErrorGroup

All Implemented Interfaces:

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

Methods

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
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	containsAtLeastOneError() Check if this group contains at least one error or fatal error message.
boolean	containsAtLeastOneFailure() Check if this group contains at least one failure message.
boolean	containsAtLeastOneSuccess() Check if this group contains at least one success message.
boolean	containsNoError() Check if this group contains no error or fatal error message.
boolean	containsNoFailure() Check if this group contains no failure message.
boolean	containsNoSuccess() Check if this group contains no success message.
boolean	containsOnlyError() Check if this group contains only error or fatal error messages.
boolean	containsOnlyFailure() Check if this group contains only failure messages.
boolean	containsOnlySuccess() Check if this group contains only success messages.
boolean	equals(Object o)
ResourceErrorGroup	getAllErrors() Get a resource error group containing only the error elements.
ResourceErrorGroup	getAllFailures() Get a resource error group containing only the failure elements.
List<IResourceError>	getAllResourceErrors() Get a list of all contained resource errors.
ResourceErrorGroup	getClone()
int	getErrorCount()
int	getFailureCount()
EErrorLevel	getMostSevereErrorLevel() Get the most severe error level within this group.
int	getSuccessCount()
int	hashCode()
boolean	isEmpty()
Iterator<IResourceError>	iterator()
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

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

addResourceErrorGroup

@Nonnull
public 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

containsOnlySuccess

public boolean containsOnlySuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains only success messages. If no item is present, false is returned.

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.

containsAtLeastOneSuccess

public 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

public boolean containsNoSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains no success message.

Specified by:

containsNoSuccess in interface IHasErrorLevels

Returns:

true if no success item is present, false otherwise.

getSuccessCount

@Nonnegative
public int getSuccessCount()

Specified by:

getSuccessCount in interface IHasErrorLevels

Returns:

The number of contained success messages. Always ≥ 0.

containsOnlyFailure

public 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

public 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

public 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.

getFailureCount

@Nonnegative
public int getFailureCount()

Specified by:

getFailureCount in interface IHasErrorLevels

Returns:

The number of contained failure messages. Always ≥ 0.

containsOnlyError

public 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

public 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

public 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.

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!

getAllFailures

@Nonnull
@ReturnsMutableCopy
public ResourceErrorGroup getAllFailures()

Description copied from interface: IResourceErrorGroup

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

Specified by:

getAllFailures in interface IResourceErrorGroup

Returns:

A resource error group containing only the failures.

getAllErrors

@Nonnull
@ReturnsMutableCopy
public ResourceErrorGroup getAllErrors()

Description copied from interface: IResourceErrorGroup

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

Specified by:

getAllErrors in interface IResourceErrorGroup

Returns:

A resource error group containing only the errors.

getMostSevereErrorLevel

@Nonnull
public EErrorLevel getMostSevereErrorLevel()

Description copied from interface: IHasErrorLevels

Get the most severe error level within this group.

Specified by:

getMostSevereErrorLevel in interface IHasErrorLevels

Returns:

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

size

@Nonnegative
public int size()

Specified by:

size 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.size()

getClone

@Nonnull
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 List<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