org.starhope.appius.except
Class DataException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.starhope.appius.except.DataException

All Implemented Interfaces:

Serializable

public class DataException
extends Exception

A DataException is thrown when a parameter that is passed into some Star-Hope routine or other is invalid, out-of-range, or badly-formed.

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private String	complaint WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) complaint (DataException)
private static long	serialVersionUID

Constructor Summary

DataException(String string)

DataException(String string, Exception e)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

String	getComplaint()
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

complaint

private final String complaint

WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) complaint (DataException)

Constructor Detail

DataException

public DataException(String string)

Parameters:

string - The string complaint, which is stored in the Exception; while it's not expected to be an internationalised or localised string, it should be concise and clear enough for programmer usage during debugging

DataException

public DataException(String string,
                     Exception e)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

string - WRITEME

e - WRITEME

Method Detail

getComplaint

public String getComplaint()

Returns:

the string value stored in the Exception

toString

public String toString()

Overrides:

toString in class Throwable

See Also:

Throwable.toString()