edu.udo.cs.yale.operator
Class UserError

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          edu.udo.cs.yale.operator.OperatorException
              edu.udo.cs.yale.operator.UserError

All Implemented Interfaces:

NoBugError, java.io.Serializable

Direct Known Subclasses:

MissingIOObjectException, UndefinedParameterError

public class UserError
extends OperatorException
implements NoBugError

Exception class whose instances are thrown due to a user error, for example missing files or wrong operator architecture.
In order to create a UserError, do the following:

• Open the file UserErrorMessages.properties in the resources directory. Look for an appropriate messsage. If you find one, remember its id number. If not, create a new one in the correct group
• The entry must include name, short message and long message. The name and long message will be presented to the user litarally. The short message will be parsed by java.text.MessageFormat. Especially, any ocurrence of curly brackets will be replaced. Be careful with quotes; it might be a good idea to read the ducumentation of MessageFormat first.
• Create a UserError by using this id. If the UserError is created because of another exception, e.g. a FileNotFoundException, this exception should be passed to the UserError in the constructor.

Version:

$Id: UserError.java,v 2.21 2006/08/03 14:39:31 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

See Also:

Serialized Form

Field Summary

private int	code
private static java.text.MessageFormat	formatter
private static java.util.ResourceBundle	messages
private Operator	operator
private static long	serialVersionUID

Constructor Summary

UserError(Operator operator, int code)
Convenience constructor for messages with no arguments.

UserError(Operator operator, int code, java.lang.Object argument1)
Convenience constructor for messages with exactly one argument.

UserError(Operator operator, int code, java.lang.Object[] arguments)

UserError(Operator operator, int code, java.lang.Object argument1, java.lang.Object argument2)
Convenience constructor for messages with exactly two arguments.

UserError(Operator operator, java.lang.Throwable cause, int code)
Convenience constructor for messages with no arguments and cause.

UserError(Operator operator, java.lang.Throwable cause, int code, java.lang.Object argument1)
Convenience constructor for messages with exactly one arguments and cause.

UserError(Operator operator, java.lang.Throwable cause, int code, java.lang.Object[] arguments)
Creates a new UserError.

Method Summary

int	getCode() Returns the error code.
java.lang.String	getDetails() Returns the error details/description.
static java.lang.String	getErrorMessage(int code, java.lang.Object[] arguments)
java.lang.String	getErrorName() Returns the error name.
java.lang.String	getHTMLMessage() Returns a html message.
Operator	getOperator()
static java.lang.String	getResourceString(int code, java.lang.String key, java.lang.String deflt) Returns a resource message for the given error code.
void	setOperator(Operator operator)

Methods inherited from class java.lang.Throwable

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

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

messages

private static java.util.ResourceBundle messages

formatter

private static final java.text.MessageFormat formatter

code

private int code

operator

private Operator operator

Constructor Detail

UserError

public UserError(Operator operator,
                 java.lang.Throwable cause,
                 int code,
                 java.lang.Object[] arguments)

Creates a new UserError.

Parameters:

operator - The Operator in which the exception occured. If operator is null, the operator is assumed to be the current operator of the current experiment (returned by Yale.getExperiment(). This may not work properly if Yale is invoked other than by calling one of the main methods.

cause - The exception that caused the user error. May be null. Using this makes debugging a lot easier.

code - The error code referring to a message in the file UserErrorMessages.properties

arguments - Arguments for the short message.

UserError

public UserError(Operator operator,
                 java.lang.Throwable cause,
                 int code)

Convenience constructor for messages with no arguments and cause.

UserError

public UserError(Operator operator,
                 int code,
                 java.lang.Object[] arguments)

UserError

public UserError(Operator operator,
                 int code)

Convenience constructor for messages with no arguments.

UserError

public UserError(Operator operator,
                 int code,
                 java.lang.Object argument1)

Convenience constructor for messages with exactly one argument.

UserError

public UserError(Operator operator,
                 java.lang.Throwable cause,
                 int code,
                 java.lang.Object argument1)

Convenience constructor for messages with exactly one arguments and cause.

UserError

public UserError(Operator operator,
                 int code,
                 java.lang.Object argument1,
                 java.lang.Object argument2)

Convenience constructor for messages with exactly two arguments.

Method Detail

getDetails

public java.lang.String getDetails()

Description copied from interface: NoBugError

Returns the error details/description.

Specified by:

getDetails in interface NoBugError

getErrorName

public java.lang.String getErrorName()

Description copied from interface: NoBugError

Returns the error name.

Specified by:

getErrorName in interface NoBugError

getCode

public int getCode()

Description copied from interface: NoBugError

Returns the error code.

Specified by:

getCode in interface NoBugError

getOperator

public Operator getOperator()

setOperator

public void setOperator(Operator operator)

getErrorMessage

public static java.lang.String getErrorMessage(int code,
                                               java.lang.Object[] arguments)

getResourceString

public static java.lang.String getResourceString(int code,
                                                 java.lang.String key,
                                                 java.lang.String deflt)

Returns a resource message for the given error code.

Parameters:

key - one out of "name", "short", "long"

getHTMLMessage

public java.lang.String getHTMLMessage()

Description copied from interface: NoBugError

Returns a html message.

Specified by:

getHTMLMessage in interface NoBugError