Package com.randomnoun.common

Class ErrorList

java.lang.Object

com.randomnoun.common.ErrorList

All Implemented Interfaces:

Serializable, Iterable<ErrorList.ErrorData>, Collection<ErrorList.ErrorData>, List<ErrorList.ErrorData>, SequencedCollection<ErrorList.ErrorData>

public class ErrorList
extends Object
implements List<ErrorList.ErrorData>, Serializable

The ErrorList class is a a fairly generic class for containing validation errors for input forms, similar to the struts ActionErrors class.

Each error within this class can contain a 'short' and 'long' description, where the short description is normally two-word categorisation of the error and the longer description describes what has happened and how to fix the problem; (e.g. shortText="Missing field", longText="The field 'id' is mandatory. Please enter a value for this field.").

In the UI, the short description is normally rendered in bold before the long description.

An individual error also may contain a severity, and list of fields that it applies to (defined by a comma-separate string of field names) An error without a severity supplied is assumed to be SEVERITY_INVALID, and an error without any fields supplied is assumed to be associated with the entire form, rather than a specific set of fields.

Errors are inserted into an ErrorList by using one of the addError methods:

• addError(String, String) - add an invalid form error
• addError(String, String, int) - add an form error with a specific severity
• addError(String, String, String) - add an invalid field error
• addError(String, String, String, int) - add an invalid field error with a specific severity

Author:

knoxg

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorList.ErrorData	ErrorInfo inner class - contains information related to a single error

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SEVERITY_ERROR	invalid system-supplied data; end-user cannot fix situation
static final int	SEVERITY_FATAL	internal error (e.g.
static final int	SEVERITY_INFO	information message; can be used in addition to SEVERITY_OK for additional text
static final int	SEVERITY_INVALID	invalid user-supplied data; end-user can fix situation
static final int	SEVERITY_OK	Severity level indicating 'not an error' (e.g.
static final int	SEVERITY_PANIC	unrecoverable internal error (can't think of anything here, but the world ending could be one
static final int	SEVERITY_WARNING	possibly incorrect user-supplied data; operation still succeeds but may return incorrect results

Constructor Summary

Constructors

Constructor	Description
ErrorList()	Create a new, empty ErrorData object.

Method Summary

Modifier and Type	Method	Description
void	add(int index, ErrorList.ErrorData element)
boolean	add(ErrorList.ErrorData e)
boolean	addAll(int index, Collection<? extends ErrorList.ErrorData> c)
boolean	addAll(Collection<? extends ErrorList.ErrorData> c)
void	addError(String shortText, String longText)	Adds an error that isn't associated with any particular field, with a default severity of SEVERITY_ERROR.
void	addError(String shortText, String longText, int severity)	Adds an error that isn't associated with any particular field
void	addError(String errorField, String shortText, String longText)	As per addError(String, String, String, int), with a default severity of SEVERITY_ERROR.
void	addError(String errorField, String shortText, String longText, int severity)	Adds an error.
boolean	addErrors(ErrorList errorList)	Appends the errors contained within another ErrorData into this one.
void	clear()
void	clearErrors()	Resets all errors contained within this object
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
void	forEach(Consumer<? super ErrorList.ErrorData> action)	Delegate methods
ErrorList.ErrorData	get(int index)
String	getFieldAt(int pos)	Returns the field of the pos'th error
String	getLongTextAt(int pos)	Returns the longText of the pos'th error
int	getSeverityAt(int pos)	Returns the severity of the pos'th error
String	getShortTextAt(int pos)	Returns the shortText string of the pos'th error
int	getSize()	Same as size().
boolean	hasErrorOn(String field)	Returns true if an error has occured on the field passed as a parameter to this method
boolean	hasErrors()	Returns true if there are any errors in this object
boolean	hasErrors(int severity)	Deprecated.
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<ErrorList.ErrorData>	iterator()
int	lastIndexOf(Object o)
ListIterator<ErrorList.ErrorData>	listIterator()
ListIterator<ErrorList.ErrorData>	listIterator(int index)
void	makeThreadsafe()	Convert the backing store for this ErrorList to a Collections.synchronizedList, suitable for use in multithreaded applications.
int	maxErrorSeverity()	Deprecated.
Stream<ErrorList.ErrorData>	parallelStream()
ErrorList.ErrorData	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
void	removeDuplicates()	Removes any duplicate errors in this ErrorList
boolean	removeIf(Predicate<? super ErrorList.ErrorData> filter)
void	replaceAll(UnaryOperator<ErrorList.ErrorData> operator)
boolean	retainAll(Collection<?> c)
ErrorList.ErrorData	set(int index, ErrorList.ErrorData element)
int	size()	Returns the number of errors in this object
void	sort(Comparator<? super ErrorList.ErrorData> c)
Spliterator<ErrorList.ErrorData>	spliterator()
Stream<ErrorList.ErrorData>	stream()
List<ErrorList.ErrorData>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toJSON()	Return the JSON representation of this object
String	toString()	Return all the errors within this object in a single string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

toArray

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed

Field Details

SEVERITY_OK

public static final int SEVERITY_OK

Severity level indicating 'not an error' (e.g. informational only). Used to indicate successful operations

See Also:

• Constant Field Values

SEVERITY_INVALID

public static final int SEVERITY_INVALID

invalid user-supplied data; end-user can fix situation

See Also:

• Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR

invalid system-supplied data; end-user cannot fix situation

See Also:

• Constant Field Values

SEVERITY_FATAL

public static final int SEVERITY_FATAL

internal error (e.g. EJB/LDAP connection failure)

See Also:

• Constant Field Values

SEVERITY_PANIC

public static final int SEVERITY_PANIC

unrecoverable internal error (can't think of anything here, but the world ending could be one

See Also:

• Constant Field Values

SEVERITY_INFO

public static final int SEVERITY_INFO

information message; can be used in addition to SEVERITY_OK for additional text

See Also:

• Constant Field Values

SEVERITY_WARNING

public static final int SEVERITY_WARNING

possibly incorrect user-supplied data; operation still succeeds but may return incorrect results

See Also:

• Constant Field Values

Constructor Details

ErrorList

public ErrorList()

Create a new, empty ErrorData object.

Method Details

makeThreadsafe

public void makeThreadsafe()

Convert the backing store for this ErrorList to a Collections.synchronizedList, suitable for use in multithreaded applications. Note that iterations on this collection must still be synchronised.

removeDuplicates

public void removeDuplicates()

Removes any duplicate errors in this ErrorList

addError

public void addError(String errorField,
 String shortText,
 String longText,
 int severity)

Adds an error. This is the "real" addError() method; all others delegate to this one.

Parameters:

errorField - a comma-separated list of field names that caused this error

shortText - a short string conveying the error type (e.g. 'Missing field')

longText - a longer string describing the nature of the error and how to resolve it (e.g. 'The field 'id' is mandatory. Please enter a value for this field.')

severity - the severity of this error (one of the SEVERITY_* constants of this class).

See Also:

• SEVERITY_INVALID

addError

public void addError(String errorField,
 String shortText,
 String longText)

As per addError(String, String, String, int), with a default severity of SEVERITY_ERROR.

Parameters:

errorField - a comma-separated list of field names that caused this error

shortText - a short string conveying the error type (e.g. 'Missing field')

longText - a longer string describing the nature of the error and how to resolve it (e.g. 'The field 'id' is mandatory. Please enter a value for this field.')

addError

public void addError(String shortText,
 String longText,
 int severity)

Adds an error that isn't associated with any particular field

Parameters:

shortText - a short string conveying the error type (e.g. 'Missing field')

longText - a longer string describing the nature of the error and how to resolve it (e.g. 'The field 'id' is mandatory. Please enter a value for this field.')

severity - the severity of this error (one of the SEVERITY_* constants of this class)

addError

public void addError(String shortText,
 String longText)

Adds an error that isn't associated with any particular field, with a default severity of SEVERITY_ERROR.

Parameters:

shortText - a short string conveying the error type (e.g. 'Missing field')

longText - a longer string describing the nature of the error and how to resolve it (e.g. 'The field 'id' is mandatory. Please enter a value for this field.')

clearErrors

public void clearErrors()

Resets all errors contained within this object

addErrors

public boolean addErrors(ErrorList errorList)

Appends the errors contained within another ErrorData into this one.

Parameters:

errorList -

Returns:

true if there were any additional errors to embed and at least one of the errors had a severity of SEVERITY_ERROR or higher (worse), false otherwise.

hasErrorOn

public boolean hasErrorOn(String field)

Returns true if an error has occured on the field passed as a parameter to this method

Returns:

true if an error occured, false if not.

hasErrors

public boolean hasErrors()

Returns true if there are any errors in this object

Returns:

True if the number of errors > 0

hasErrors

public boolean hasErrors(int severity)

Deprecated.

Returns true if there are any errors of the specified severity or higher Note that our severities aren't in increasing severity order any more so this method is now deprecated

Parameters:

severity - a SEVERITY_* constant

Returns:

True if the number of errors at the specified severity or higher > 0

maxErrorSeverity

public int maxErrorSeverity()

Deprecated.

Returns the maximum severity of all current errors. Note that our severities aren't in increasing severity order any more so this method is now deprecated

Returns:

the severity ranking of the most severe error, or -1 if there are no errors contained within this ErrorData object.

size

public int size()

Returns the number of errors in this object

Specified by:

size in interface Collection<ErrorList.ErrorData>

Specified by:

size in interface List<ErrorList.ErrorData>

Returns:

The number of errors in this object

getSize

public int getSize()

Same as size(). Only here to allow us to access the object in JSTL

Returns:

The number of errors in this object

getShortTextAt

public String getShortTextAt(int pos)

Returns the shortText string of the pos'th error

getLongTextAt

public String getLongTextAt(int pos)

Returns the longText of the pos'th error

getFieldAt

public String getFieldAt(int pos)

Returns the field of the pos'th error

getSeverityAt

public int getSeverityAt(int pos)

Returns the severity of the pos'th error

toString

public String toString()

Return all the errors within this object in a single string. Suitable for inclusion within email alarms, logs etc...

Overrides:

toString in class Object

Returns:

Newline-separated list of errors

toJSON

public String toJSON()

Return the JSON representation of this object

Returns:

the JSON representation of this object

forEach

public void forEach(Consumer<? super ErrorList.ErrorData> action)

Delegate methods

Specified by:

forEach in interface Iterable<ErrorList.ErrorData>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<ErrorList.ErrorData>

Specified by:

isEmpty in interface List<ErrorList.ErrorData>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<ErrorList.ErrorData>

Specified by:

contains in interface List<ErrorList.ErrorData>

iterator

public Iterator<ErrorList.ErrorData> iterator()

Specified by:

iterator in interface Collection<ErrorList.ErrorData>

Specified by:

iterator in interface Iterable<ErrorList.ErrorData>

Specified by:

iterator in interface List<ErrorList.ErrorData>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<ErrorList.ErrorData>

Specified by:

toArray in interface List<ErrorList.ErrorData>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<ErrorList.ErrorData>

Specified by:

toArray in interface List<ErrorList.ErrorData>

add

public boolean add(ErrorList.ErrorData e)

Specified by:

add in interface Collection<ErrorList.ErrorData>

Specified by:

add in interface List<ErrorList.ErrorData>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<ErrorList.ErrorData>

Specified by:

remove in interface List<ErrorList.ErrorData>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<ErrorList.ErrorData>

Specified by:

containsAll in interface List<ErrorList.ErrorData>

addAll

public boolean addAll(Collection<? extends ErrorList.ErrorData> c)

Specified by:

addAll in interface Collection<ErrorList.ErrorData>

Specified by:

addAll in interface List<ErrorList.ErrorData>

addAll

public boolean addAll(int index,
 Collection<? extends ErrorList.ErrorData> c)

Specified by:

addAll in interface List<ErrorList.ErrorData>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<ErrorList.ErrorData>

Specified by:

removeAll in interface List<ErrorList.ErrorData>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<ErrorList.ErrorData>

Specified by:

retainAll in interface List<ErrorList.ErrorData>

replaceAll

public void replaceAll(UnaryOperator<ErrorList.ErrorData> operator)

Specified by:

replaceAll in interface List<ErrorList.ErrorData>

removeIf

public boolean removeIf(Predicate<? super ErrorList.ErrorData> filter)

Specified by:

removeIf in interface Collection<ErrorList.ErrorData>

sort

public void sort(Comparator<? super ErrorList.ErrorData> c)

Specified by:

sort in interface List<ErrorList.ErrorData>

clear

public void clear()

Specified by:

clear in interface Collection<ErrorList.ErrorData>

Specified by:

clear in interface List<ErrorList.ErrorData>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<ErrorList.ErrorData>

Specified by:

equals in interface List<ErrorList.ErrorData>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<ErrorList.ErrorData>

Specified by:

hashCode in interface List<ErrorList.ErrorData>

Overrides:

hashCode in class Object

get

public ErrorList.ErrorData get(int index)

Specified by:

get in interface List<ErrorList.ErrorData>

set

public ErrorList.ErrorData set(int index,
 ErrorList.ErrorData element)

Specified by:

set in interface List<ErrorList.ErrorData>

add

public void add(int index,
 ErrorList.ErrorData element)

Specified by:

add in interface List<ErrorList.ErrorData>

stream

public Stream<ErrorList.ErrorData> stream()

Specified by:

stream in interface Collection<ErrorList.ErrorData>

remove

public ErrorList.ErrorData remove(int index)

Specified by:

remove in interface List<ErrorList.ErrorData>

parallelStream

public Stream<ErrorList.ErrorData> parallelStream()

Specified by:

parallelStream in interface Collection<ErrorList.ErrorData>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<ErrorList.ErrorData>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<ErrorList.ErrorData>

listIterator

public ListIterator<ErrorList.ErrorData> listIterator()

Specified by:

listIterator in interface List<ErrorList.ErrorData>

listIterator

public ListIterator<ErrorList.ErrorData> listIterator(int index)

Specified by:

listIterator in interface List<ErrorList.ErrorData>

subList

public List<ErrorList.ErrorData> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<ErrorList.ErrorData>

spliterator

public Spliterator<ErrorList.ErrorData> spliterator()

Specified by:

spliterator in interface Collection<ErrorList.ErrorData>

Specified by:

spliterator in interface Iterable<ErrorList.ErrorData>

Specified by:

spliterator in interface List<ErrorList.ErrorData>