com.platform.ego.exception
Class EGOException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.platform.ego.exception.EGOException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AuthenticationException, ExecutionException, NoSuchObjectException, ObjectInUseException, ParameterException, ServerException, SystemException

public class EGOException
extends java.lang.Exception

Signals that an EGO exception has occurred. This class is the general class of exceptions produced by failed or interrupted EGO operations.

Version:
1.2.3
See Also:
Serialized Form

Field Summary
protected  java.lang.String area
           
protected  java.lang.Object[] args
           
protected  int errorCode
           
protected  java.lang.String errorMessage
           
protected  java.lang.String funName
           
protected  java.lang.Throwable rootCause
           
 
Constructor Summary
EGOException()
          Construct a blank instance.
EGOException(int errorCode)
          Construct an instance using a given error code.
EGOException(int errorCode, java.lang.String message)
          Construct an instance using a given message and error code.
EGOException(int errorCode, java.lang.String message, java.lang.Object[] args)
          Construct an instance using a given message, error code and arguments.
EGOException(int errorCode, java.lang.String message, java.lang.Object[] args, java.lang.Throwable rootCause)
          Construct an instance using a given message, code of error, arguments and nested exception.
EGOException(int errorCode, java.lang.String message, java.lang.Throwable rootCause)
          Construct an instance using error code, a given message and nested exception.
EGOException(int errorCode, java.lang.Throwable rootCause)
          Construct an instance by a given message and nested exception.
EGOException(java.lang.String area, int errorCode, java.lang.String message)
          Construct an instance area of function, using error code and a given message.
EGOException(java.lang.String area, int errorCode, java.lang.String message, java.lang.Throwable rootCause)
          Construct an instance area of function, using error code, a given message and nested exception.
EGOException(java.lang.String message, java.lang.Throwable rootCause)
          Construct an instance using a given message and nested exception.
EGOException(java.lang.Throwable rootCause)
          Construct an instance by a root cause of this exception.
 
Method Summary
 java.lang.String getArea()
          Get area of function that produces the error.
 java.lang.Object[] getArgs()
          Get arguments used to bundle message from resource file.
 int getErrorCode()
          Get error code.
 java.lang.Throwable getRootCause()
          Get root cause of the exception.
 void printStackTrace()
           
 void printStackTrace(java.io.PrintStream outStream)
           
 void printStackTrace(java.io.PrintWriter writer)
           
 void setArea(java.lang.String area)
          Set area of function that produces the error.
 void setArgs(java.lang.Object[] args)
          Set message arguments used to bundle message from resource file.
 void setErrorCode(int key)
          Set error code.
 void setRootCause(java.lang.Throwable anException)
          Set root cause of the exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

rootCause

protected java.lang.Throwable rootCause

funName

protected java.lang.String funName

area

protected java.lang.String area

errorMessage

protected java.lang.String errorMessage

errorCode

protected int errorCode

args

protected java.lang.Object[] args
Constructor Detail

EGOException

public EGOException()
Construct a blank instance.


EGOException

public EGOException(int errorCode)
Construct an instance using a given error code.

Parameters:
errorCode - : specify error code.

EGOException

public EGOException(int errorCode,
                    java.lang.String message)
Construct an instance using a given message and error code.

Parameters:
errorCode - : specify error code.
message - : specify an exception message.

EGOException

public EGOException(int errorCode,
                    java.lang.String message,
                    java.lang.Object[] args)
Construct an instance using a given message, error code and arguments.

Parameters:
errorCode - : specify error code.
message - : specify an exception message.
args - : specify arguments used to bundle resources.

EGOException

public EGOException(int errorCode,
                    java.lang.String message,
                    java.lang.Object[] args,
                    java.lang.Throwable rootCause)
Construct an instance using a given message, code of error, arguments and nested exception.

Parameters:
errorCode - : specify error code.
message - : specify an exception message.
args - : specify arguments used to bundle resources.
rootCause - : specify nested exception.

EGOException

public EGOException(java.lang.String message,
                    java.lang.Throwable rootCause)
Construct an instance using a given message and nested exception.

Parameters:
message - : specify an exception message.
rootCause - : specify nested exception.

EGOException

public EGOException(int errorCode,
                    java.lang.String message,
                    java.lang.Throwable rootCause)
Construct an instance using error code, a given message and nested exception.

Parameters:
errorCode - : specify error code.
message - : specify an exception message.
rootCause - : specify nested exception.

EGOException

public EGOException(java.lang.String area,
                    int errorCode,
                    java.lang.String message,
                    java.lang.Throwable rootCause)
Construct an instance area of function, using error code, a given message and nested exception.

Parameters:
area - : specify area of function.
errorCode - : specify error code.
message - : specify an exception message.
rootCause - : specify nested exception.

EGOException

public EGOException(java.lang.String area,
                    int errorCode,
                    java.lang.String message)
Construct an instance area of function, using error code and a given message.

Parameters:
area - : specify area of function.
errorCode - : specify error code.
message - : specify an exception message.

EGOException

public EGOException(int errorCode,
                    java.lang.Throwable rootCause)
Construct an instance by a given message and nested exception.

Parameters:
errorCode - : specify error code.
rootCause - : Specify nested exception.

EGOException

public EGOException(java.lang.Throwable rootCause)
Construct an instance by a root cause of this exception.

Parameters:
rootCause - : specify the root cause of this exception.
Method Detail

setErrorCode

public void setErrorCode(int key)
Set error code.

Parameters:
key - : specify error code.

getErrorCode

public int getErrorCode()
Get error code.

Returns:
error code string.

setArgs

public void setArgs(java.lang.Object[] args)
Set message arguments used to bundle message from resource file.

Parameters:
args - : specify arguments array to be set.

getArgs

public java.lang.Object[] getArgs()
Get arguments used to bundle message from resource file.

Returns:
arguments used to bundle message from resource file.

setRootCause

public void setRootCause(java.lang.Throwable anException)
Set root cause of the exception.

Parameters:
anException - root cause to be set.

getRootCause

public java.lang.Throwable getRootCause()
Get root cause of the exception.

Returns:
root cause of the exception.

getArea

public java.lang.String getArea()
Get area of function that produces the error.


setArea

public void setArea(java.lang.String area)
Set area of function that produces the error.

Parameters:
area - : specify area of function.

printStackTrace

public void printStackTrace()
Overrides:
printStackTrace in class java.lang.Throwable
See Also:
Throwable.printStackTrace()

printStackTrace

public void printStackTrace(java.io.PrintStream outStream)
Overrides:
printStackTrace in class java.lang.Throwable
See Also:
Throwable.printStackTrace(java.io.PrintStream)

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)
Overrides:
printStackTrace in class java.lang.Throwable
See Also:
Throwable.printStackTrace(java.io.PrintWriter)


Copyright (C) 1992-2007 Platform Computing Corporation