|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.util.parameter.ErrorList
Subject to change.
A collection to store ParameterError
s that are
encountered during parameter reading or validation. This
collection is used in the lifecycle methods of
Parameter
. It is ordinarily returned to the
parameter-using code so that it can handle errors.
ParameterError
,
Parameter
Field Summary | |
static String |
versionId
|
Constructor Summary | |
ErrorList()
Constructs a new error list. |
Method Summary | |
void |
add(ParameterError error)
Adds error to the error list. |
void |
check()
Throws a ParameterException containing the error
list. |
boolean |
isEmpty()
Tells whether the error collection is empty or not. |
Iterator |
iterator()
Gets an iterator over the currently stored errors. |
void |
report(Writer out)
Prints parameter errors to out with formatting
appropriate to the console. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String versionId
Constructor Detail |
public ErrorList()
Method Detail |
public final void add(ParameterError error)
error
to the error list.
error
- A ParameterError
representing a read
or validation error; it cannot be nullpublic final Iterator iterator()
Iterator
of
ParameterError
s; it cannot be nullParameterError
public final boolean isEmpty()
true
if the collection is empty, otherwise
false
public final void check() throws ParameterException
ParameterException
containing the error
list. This method is for use when the client code wants the
program to fail via an exception if there are errors.
ParameterException
- if the error list is not emptypublic final void report(Writer out)
out
with formatting
appropriate to the console.
out
- The Writer
to print the errors to
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |