cern.cmw
Class IOError

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          cern.cmw.CmwException
              cern.cmw.IOError

All Implemented Interfaces:

Serializable

public class IOError
extends CmwException

Indicates an error in the low level I/O software/firmware/hardware used in the device servers.

Each IOError provides several kinds of information:

• a string describing the error. This is used as the Java Exception message, available via the method getMessage.
• a string that identifies the error category. This is typically a name of the I/O package or driver which emitted the error. For example, "PS-GM", "SL-EQUIP", "CAMAC", "GPIB", etc.. Possible values of the category string are described in the device servers documentation.
• an integer error code that is specific to each category. Normally this will be the actual error code returned by the underlying I/O package.
• an optional Data object (null if none) which can be used to provide additional error information.

See Also:

Data, Serialized Form

Constructor Summary

IOError(String errorCategory, int errorCode, String message)
Constructs an IOError exception; details defaults to null.

IOError(String errorCategory, int errorCode, String message, Data details)
Constructs a fully-specified IOError exception.

Method Summary

String	getCategory() Returns the category string for this exception.
int	getCode() Returns the error code for this exception.
Data	getDetails() Returns additional error information for this exception, packed into a Data container, or null if the details are not available.
String	toString() Returns a string representation of this IOError.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IOError

public IOError(String errorCategory,
               int errorCode,
               String message,
               Data details)

Constructs a fully-specified IOError exception.

IOError

public IOError(String errorCategory,
               int errorCode,
               String message)

Constructs an IOError exception; details defaults to null.

Method Detail

getCategory

public String getCategory()

Returns the category string for this exception.

getCode

public int getCode()

Returns the error code for this exception.

getDetails

public Data getDetails()

Returns additional error information for this exception, packed into a Data container, or null if the details are not available.

toString

public String toString()

Returns a string representation of this IOError. The string format is:

 cern.cmw.IOError: ["category" - "code"] "message" 
 

Note that details data is not included in the string: you can use Data.toString() to stringify this field separately.

Overrides:

toString in class Throwable