uk.ac.ed.epcc.safe.accounting

Class ErrorSet

java.lang.Object

uk.ac.ed.epcc.safe.accounting.ErrorSet

public class ErrorSet
extends java.lang.Object

Collection of error messages. Where it is not possible to report errors as they occur, For example when parsing accounting data. An ErrorSet can be used to store all errors for later reporting. Each error is recorded as a general type and specific details. This allows the class to generate a summary report giving just the numbers of errors of each general class.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorSet.Detail
static class	ErrorSet.Entry

Constructor Summary

Constructors

Constructor and Description
ErrorSet()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String text, java.lang.String data) Add an error
void	add(java.lang.String text, java.lang.String data, java.lang.Throwable t)
<X extends uk.ac.ed.epcc.webapp.content.ContentBuilder> X	addContent(X cb, int nprint)
java.lang.String	details()
java.lang.String	details(int nprint) Generate text precis of the errors The data texts will only be printed if there are less than nprint values or if nprint is -1.
java.util.Collection<ErrorSet.Detail>	getAllErrorDetails() Returns the details of all the errors that are stored in this ErrorSet.
java.util.Collection<ErrorSet.Entry>	getEntries()
void	report(uk.ac.ed.epcc.webapp.AppContext c)
void	report(uk.ac.ed.epcc.webapp.logging.Logger l)
void	setName(java.lang.String name)
int	size()
java.lang.String	toString()
void	traceback(java.io.PrintStream s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorSet

public ErrorSet()

Method Detail

size

public int size()

setName

public void setName(java.lang.String name)

add

public void add(java.lang.String text,
       java.lang.String data)

Add an error

Parameters:

text - String general class or error

data - String specific details of this error

add

public void add(java.lang.String text,
       java.lang.String data,
       java.lang.Throwable t)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

details

public java.lang.String details()

details

public java.lang.String details(int nprint)

Generate text precis of the errors The data texts will only be printed if there are less than nprint values or if nprint is -1.

Parameters:

nprint - target number of lines

Returns:

String

addContent

public <X extends uk.ac.ed.epcc.webapp.content.ContentBuilder> X addContent(X cb,
                                                                   int nprint)

getEntries

public java.util.Collection<ErrorSet.Entry> getEntries()

Returns:

All error entries that have been recorded by this ErrorSet

getAllErrorDetails

public java.util.Collection<ErrorSet.Detail> getAllErrorDetails()

Returns the details of all the errors that are stored in this ErrorSet. Detail objects contain the data that coursed the error and may contain the Throwable that represents the error too. The number of times the error occured is not recorded in a Detail object. For this kind of information, use getEntries() instead.

Returns:

details of all the different errors that are recorded in this ErrorSet

traceback

public void traceback(java.io.PrintStream s)

report

public void report(uk.ac.ed.epcc.webapp.AppContext c)

report

public void report(uk.ac.ed.epcc.webapp.logging.Logger l)