com.tridion.util

Class ErrorList

java.lang.Object

com.tridion.util.ErrorList

public class ErrorList
extends Object

The ErrorList class maintains a list of all Exceptions or error messages that are set by another functional class. Besides this, it also logs them to the supplied Logger instance.

Constructor Summary

Constructors

Constructor and Description
ErrorList() Creates a new ErrorList.

Method Summary

Modifier and Type	Method and Description
boolean	getLastError() This method will indicate if the last call to a Presentation Function in this class resulted in an error, and will retrieve information about this error.
String	getLastErrorMessage() This method will return the last error message, stored after the first call to setError() after the last call to resetLastError(), or stored after the first call to setError() after the creation of this object.
String	getLastStackTrace() This method will return the stacktrace of the last Exception, which was stored after the first call to setError() after the last call to resetLastError(), or the first call to this method after the creation of this object.
void	resetLastError() This method will reset the error information in this object.
void	setError(Exception e) Stores information on this exception in this object, if after the last call to resetLastError() no other error is set.
void	setError(String errorMessage) Stores information about an error situation, if after the last call to resetLastError() no other error is set.
void	setError(String message, Exception e) Stores information on this exception in this object, if after the last call to resetLastError() no other error is set.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorList

public ErrorList()

Creates a new ErrorList. The Logger object that is passed in the constructor is used to log error messages that are set to the log file.

Method Detail

setError

public void setError(Exception e)

Stores information on this exception in this object, if after the last call to resetLastError() no other error is set.

Parameters:

e - the exception to store this information about.

setError

public void setError(String message,
                     Exception e)

Stores information on this exception in this object, if after the last call to resetLastError() no other error is set.

Parameters:

message - The message for the exception to be set.

e - The exception to store this information about.

setError

public void setError(String errorMessage)

Stores information about an error situation, if after the last call to resetLastError() no other error is set.

Parameters:

errorMessage - the message that should be set.

resetLastError

public void resetLastError()

This method will reset the error information in this object. It should be called from within presentation functions: it should be the first call presentation functions make, before actually preforming their real work.

getLastError

public boolean getLastError()

This method will indicate if the last call to a Presentation Function in this class resulted in an error, and will retrieve information about this error. It will not reset this error information.

Returns:

true if the last call to one of the methods resulted in an error/exception and false if not.

getLastErrorMessage

public String getLastErrorMessage()

This method will return the last error message, stored after the first call to setError() after the last call to resetLastError(), or stored after the first call to setError() after the creation of this object. The method getLastError() can be called to check if an error occurred.

Returns:

a new String object containing the message describing the error, if an error occurred. A new empty String is returned if no error occurred.

getLastStackTrace

public String getLastStackTrace()

This method will return the stacktrace of the last Exception, which was stored after the first call to setError() after the last call to resetLastError(), or the first call to this method after the creation of this object. The method getLastError() can be called to check if an error occurred.

Returns:

a new String object containing the stacktrace, if an error occurred. A new empty String is returned if no error occurred.