Overview  Package   Class  Use  Deprecated  Index
Home >> All >> arch >> message >> [ error overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

arch.message.error
Class JXError  

java.lang.Object
  arch.message.JXMessage
      arch.message.error.JXError

---

public class JXError

extends arch.message.JXMessage

JXError defines an user customized error that describes what went wrong while performing a job. It provides the facility to associate a JVM stack trace to the error so that the error can be debugged. The error message object passed is not interpreted by the class but is left to the client Object to interpret it. Its main design is to provide a standardized system wide error object handling facility such that it will facilitate system message logging and response handling. Note: Most of the main abstract classes are designed to return an error object instead of throwing an exception for reasons due to efficiency and class contract simplicity.

Since:

JD4X 1.0

Version:

0.1, 03/06/2002

---

Field Summary
private  java.lang.StackTraceElement[]	stack           The JVM stack associated with this error.

 

Fields inherited from class arch.message.JXMessage

 

Constructor Summary

JXError()           The default constructor that creates an error without a stack trace.

JXError(java.lang.Object msg)           This construct is used when a known customized error message is required but no specific JVM stack is associated with this error.

JXError(java.lang.Object msg, java.lang.StackTraceElement[] st)           This construct is used when a serious error has resulted and a valid JVM stack trace is available for debugging.

 

Method Summary
java.lang.StackTraceElement[]	getErrorStack()           Provides a general way to pass the error stack to its clients.
static void	printError(JXError error)           Print a standard JXError.
java.lang.String	toString()           A String representation of the error.

 

Methods inherited from class arch.message.JXMessage

equals, getMessage, hashCode, setMessage

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

stack

private java.lang.StackTraceElement[] stack

The JVM stack associated with this error.

Constructor Detail

JXError

public JXError()

The default constructor that creates an error without a stack trace. This error construct is used for unknown user defined errors that contain no known stack trace element and no known error message. This constructor should generally be used for testing purposes only.

---

JXError

public JXError(java.lang.Object msg)

This construct is used when a known customized error message is required but no specific JVM stack is associated with this error.

---

JXError

public JXError(java.lang.Object msg,
               java.lang.StackTraceElement[] st)

This construct is used when a serious error has resulted and a valid JVM stack trace is available for debugging.

Method Detail

getErrorStack

public final java.lang.StackTraceElement[] getErrorStack()

Provides a general way to pass the error stack to its clients.

---

printError

public static void printError(JXError error)

Print a standard JXError.

---

toString

public java.lang.String toString()

A String representation of the error. The exact details of the representation are unspecified and subject to change, but the following maybe regarded as typical: JD4X Error: Error initializing Junk server socket with port==123 and depth==5.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> arch >> message >> [ error overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---