de.ipcon.tools

Class ErrorCollector

java.lang.Object

de.ipcon.tools.ErrorCollector

public class ErrorCollector
extends java.lang.Object

Helper class that collects errors (exceptions) for Object instances, with special summarizing if the same exceptions are signalled multiple times.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorCollector.ErrorInfo
static class	ErrorCollector.ErrorInfos

Constructor Summary

Constructors

Constructor and Description
ErrorCollector()

Method Summary

Modifier and Type	Method and Description
ErrorCollector.ErrorInfos	addError(java.lang.Object forObject, java.lang.Exception ex) Stores - if no error (exception) of the given type occurred until now - or otherwise updates info about the given error for the given object.
ErrorCollector.ErrorInfos	addError(java.lang.Object forObject, java.lang.Exception ex, java.lang.String msg)
void	clearErrors(java.lang.Object forObject) Clears all stored error infos for the given object.
void	dumpToLog(org.apache.log4j.Logger log) Dumps the information from this ErrorCollector instance to the given Logger.
void	dumpToLog(org.apache.log4j.Logger log, org.apache.log4j.Level level)
java.util.HashMap<java.lang.Object,ErrorCollector.ErrorInfos>	getErrorinfosByObject() Class that stores info about different kinds of errors for one object.
ErrorCollector.ErrorInfos	getErrors(java.lang.Object forObject) Gets error infos stored for the given object.
boolean	hasErrors() Returns if any errors have been stored yet.
boolean	hasErrorsFor(java.lang.Object forObject) Returns if errors for the given object have been stored yet.
void	logAndStoreProblem(org.apache.log4j.Logger log, java.lang.Object forObject, java.lang.Exception ex, java.lang.String msg) Logs the given message and exception and stores the info in this ErrorCollector too.
void	logAndStoreProblem(org.apache.log4j.Logger log, java.lang.Object forObject, java.lang.Exception ex, java.lang.String msg, org.apache.log4j.Level level)
void	setErrorinfosByObject(java.util.HashMap<java.lang.Object,ErrorCollector.ErrorInfos> $5)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorCollector

public ErrorCollector()

Method Detail

addError

public ErrorCollector.ErrorInfos addError(java.lang.Object forObject,
                                          java.lang.Exception ex)

Stores - if no error (exception) of the given type occurred until now - or otherwise updates info about the given error for the given object.

Parameters:

forObject - the Object that caused or was affected by the error

ex - the Exception that occurred and for which info should be initially stored or updated

msg - an optional, additional message that should be stored with the error; should a previous message for the exception type exist it will be overwritten with this new one, if one is given

Returns:

the ErrorInfos instance which stores error infos for the given object

addError

public ErrorCollector.ErrorInfos addError(java.lang.Object forObject,
                                          java.lang.Exception ex,
                                          java.lang.String msg)

hasErrors

public boolean hasErrors()

Returns if any errors have been stored yet.

Returns:

true if any errors have been stored yet, false otherwise

hasErrorsFor

public boolean hasErrorsFor(java.lang.Object forObject)

Returns if errors for the given object have been stored yet.

Returns:

true if any errors for the given object have been stored yet, false otherwise

getErrors

public ErrorCollector.ErrorInfos getErrors(java.lang.Object forObject)

Gets error infos stored for the given object.

Parameters:

forObject - the Object for which error info is wanted

Returns:

the ErrorInfos instance which stores error infos for the given object; null if no info is stored for that object

clearErrors

public void clearErrors(java.lang.Object forObject)

Clears all stored error infos for the given object.

Parameters:

forObject - the Object for which error infos should be cleared

dumpToLog

public void dumpToLog(org.apache.log4j.Logger log)

Dumps the information from this ErrorCollector instance to the given Logger. Mainly for debugging purposes.

Parameters:

log - the Logger to dump the info to

dumpToLog

public void dumpToLog(org.apache.log4j.Logger log,
                      org.apache.log4j.Level level)

logAndStoreProblem

public void logAndStoreProblem(org.apache.log4j.Logger log,
                               java.lang.Object forObject,
                               java.lang.Exception ex,
                               java.lang.String msg)

Logs the given message and exception and stores the info in this ErrorCollector too.

logAndStoreProblem

public void logAndStoreProblem(org.apache.log4j.Logger log,
                               java.lang.Object forObject,
                               java.lang.Exception ex,
                               java.lang.String msg,
                               org.apache.log4j.Level level)

getErrorinfosByObject

public java.util.HashMap<java.lang.Object,ErrorCollector.ErrorInfos> getErrorinfosByObject()

Class that stores info about different kinds of errors for one object.

setErrorinfosByObject

public void setErrorinfosByObject(java.util.HashMap<java.lang.Object,ErrorCollector.ErrorInfos> $5)