org.dmd.util.exceptions

Class ResultException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.dmd.util.exceptions.ResultException

All Implemented Interfaces:

Serializable

public class ResultException
extends Exception

The ResultException encapsulates a ResultSet that can be populated with a variety of errors/warning when it's thrown. Once created, add your information to the public result member.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ResultSet	result The result set.

Constructor Summary

Constructors

Constructor and Description
ResultException() Constructs a new result set exception.
ResultException(Exception e) Constructs a new result set exception with info from the exception.
ResultException(ResultSet rs) Constructs a new result set exception with a result set.
ResultException(String s) Constructs a new result set exception with a detailed message.
ResultException(String s, ResultSet rs) Constructs a new result set exception with a detailed message and a result set.

Method Summary

Modifier and Type	Method and Description
void	addError(String msg) A convenience method to add a Result.ERROR.
void	addError(String msg, String file, int line) A convenience method to add a Result.ERROR.
void	addErrorWithStack(String msg, Exception exception) A convenience method to add a Result.ERROR with a stack trace in the moreMessages part.
void	addErrorWithStack(String msg, String stack) A convenience method to add a Result.ERROR with a stack trace in the moreMessages part.
void	addFatalWithStack(String msg, Exception exception) A convenience method to add a Result.FATAL with a stack trace in the moreMessages part.
void	moreMessages(String msg) Adds more messages to the last result.
void	populate(ResultSet rs) This is a convenience function to populate an existing result set with the contents of this exception.
void	setLocationInfo(String f, int l) A convenience function to set the file and line number on the last result that was added.
String	toString() Dumps the result set.
Object	userData(String key)
void	userData(String key, Object value) Store arbitrary data with this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

result

public ResultSet result

The result set.

Constructor Detail

ResultException

public ResultException()

Constructs a new result set exception.

ResultException

public ResultException(String s)

Constructs a new result set exception with a detailed message.

Parameters:

s - String the message

ResultException

public ResultException(Exception e)

Constructs a new result set exception with info from the exception.

Parameters:

e - The exception on which the ResultExcpetion is based.

ResultException

public ResultException(ResultSet rs)

Constructs a new result set exception with a result set.

Parameters:

rs - ResultSet the result set

ResultException

public ResultException(String s,
                       ResultSet rs)

Constructs a new result set exception with a detailed message and a result set.

Parameters:

s - String the message

rs - ResultSet the result set

Method Detail

userData

public void userData(String key,
                     Object value)

Store arbitrary data with this exception.

Parameters:

key - the key to store to

value - the data

userData

public Object userData(String key)

Parameters:

key - a previously added key

Returns:

the associated data if the key existing

toString

public String toString()

Dumps the result set.

Overrides:

toString in class Throwable

populate

public void populate(ResultSet rs)

This is a convenience function to populate an existing result set with the contents of this exception. This is a stop gap mechanism until the day we eliminate direct use of result sets.

addError

public void addError(String msg)

A convenience method to add a Result.ERROR.

Parameters:

msg - String the error message

addError

public void addError(String msg,
                     String file,
                     int line)

A convenience method to add a Result.ERROR.

Parameters:

msg - String the error message

addErrorWithStack

public void addErrorWithStack(String msg,
                              String stack)

A convenience method to add a Result.ERROR with a stack trace in the moreMessages part.

Parameters:

msg - String the error message

stack - String the stack trace

addErrorWithStack

public void addErrorWithStack(String msg,
                              Exception exception)

A convenience method to add a Result.ERROR with a stack trace in the moreMessages part.

Parameters:

msg - String the error message

exception - The exception whose stack we'll display.

addFatalWithStack

public void addFatalWithStack(String msg,
                              Exception exception)

A convenience method to add a Result.FATAL with a stack trace in the moreMessages part.

Parameters:

msg - String the error message

exception - The exception whose stack we'll display.

setLocationInfo

public void setLocationInfo(String f,
                            int l)

A convenience function to set the file and line number on the last result that was added.

Parameters:

f - The file name.

l - The line number.

moreMessages

public void moreMessages(String msg)

Adds more messages to the last result.

Parameters:

msg - The message to be added.