net.pwall.util

Class UserError

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.pwall.util.UserError

All Implemented Interfaces:

Serializable

public class UserError
extends RuntimeException

A class to represent errors in user input - for example, command-line arguments incorrectly specified. This class of error differs from general exceptions in that the stack trace information is never required, and a nested exception is irrelevant. The class is derived from RuntimeException so that it can be thrown from locations that would not allow a checked exception (like the run() method of the Runnable interface).

Author:

Peter Wall

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	defaultFormat
static String	formatKey

Constructor Summary

Constructors

Constructor and Description
UserError(String msg) Construct a UserError with the supplied error message.

Method Summary

Modifier and Type	Method and Description
void	printStackTrace() Print the stack trace for this error.
void	printStackTrace(PrintStream ps) Print the stack trace for this error to a specified PrintStream.
void	printStackTrace(PrintWriter pw) Print the stack trace for this error to a specified PrintWriter.
String	toString() Create a String representation of the UserError.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

formatKey

public static final String formatKey

defaultFormat

public static final String defaultFormat

See Also:

Constant Field Values

Constructor Detail

UserError

public UserError(String msg)

Construct a UserError with the supplied error message.

Parameters:

msg - the error message

Method Detail

printStackTrace

public void printStackTrace()

Print the stack trace for this error. This method overrides the default behaviour to output only the error line and not the stack trace.

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream ps)

Print the stack trace for this error to a specified PrintStream. This method overrides the default behaviour to output only the error line and not the stack trace.

Overrides:

printStackTrace in class Throwable

Parameters:

ps - the PrintStream

printStackTrace

public void printStackTrace(PrintWriter pw)

Print the stack trace for this error to a specified PrintWriter. This method overrides the default behaviour to output only the error line and not the stack trace.

Overrides:

printStackTrace in class Throwable

Parameters:

pw - the PrintWriter

toString

public String toString()

Create a String representation of the UserError. This method uses a system property to determine the display format of the error.

Overrides:

toString in class Throwable

Returns:

the string representation of the error