GiciException
Class ParameterException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          GiciException.ParameterException

All Implemented Interfaces:

java.io.Serializable

public class ParameterException
extends java.lang.Exception

This class is an exception for parameter programs. It's useful to diferenciate it from other class of exception.

Version:

1.1

Author:

Group on Interactive Coding of Images (GICI)

See Also:

Serialized Form

Field Summary

(package private) int

errorCode An error code.

Constructor Summary

ParameterException()
Default constructor.

ParameterException(java.lang.String message)
Constructor with message.

ParameterException(java.lang.String message, int errorCode)
Constructor with error code and message.

Method Summary

int	getErrorCode() Returns the error code of this exception.

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

errorCode

int errorCode

An error code.

Values are usually defined by the application which uses this class. If this parameter is not set, the value is -1.

Constructor Detail

ParameterException

public ParameterException()

Default constructor. When an exception without any message is thrown, a default message will be used.

ParameterException

public ParameterException(java.lang.String message)

Constructor with message. The message will be passed through Exception class.

Parameters:

message - an string that contains the message exception

ParameterException

public ParameterException(java.lang.String message,
                          int errorCode)

Constructor with error code and message. The message will be passed through Exception class.

Parameters:

message - an string that contains the message exception

errorCode - the error code

Method Detail

getErrorCode

public int getErrorCode()

Returns the error code of this exception.

Returns:

errorCode defined in errorCode