org.jwalk
Class JWalkException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.jwalk.JWalkException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ExecutionException, GeneratorException, LoaderException, PermissionException, SettingsException

public class JWalkException
extends java.lang.Exception

JWalkException is the top-level exception handled by JWalk. Exceptional conditions generated by the JWalk tool suite may be handled selectively by catching the subclasses of this kind of exception. These include: LoaderException, SettingsException, PermissionException, GeneratorException and ExecutionException.

Version:

1.1

Author:

Anthony Simons

See Also:

Serialized Form

Constructor Summary

JWalkException(java.lang.String message, Error error)
Creates a JWalkException with an error message and error value.

Method Summary

Error

getError() Returns the enumerated error value.

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

Constructor Detail

JWalkException

public JWalkException(java.lang.String message,
                      Error error)

Creates a JWalkException with an error message and error value.

Parameters:

message - the short error message.

error - the enumerated error value.

Method Detail

getError

public Error getError()

Returns the enumerated error value. This is one of: {LOADER_ERROR, SETTINGS_ERROR, PERMISSIONS_ERROR, GENERATOR_ERROR, EXECUTION_ERROR}. Clients may distinguish different kinds of JWalkException based on this value.

Returns:

the error value.