com.ibm.etill.framework.log
Class ETillCassetteException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.ibm.etill.framework.log.ETillRuntimeException
                          |
                          +--com.ibm.etill.framework.log.ETillCassetteException
All Implemented Interfaces:
Serializable

public class ETillCassetteException
extends ETillRuntimeException

Throwing ETillCassetteException causes the cassette to shut down. Cassettes may throw this exception in extreme, unrecoverable situations.

See Also:
Serialized Form

Fields inherited from class com.ibm.etill.framework.log.ETillRuntimeException
RE_CASSETTE_ERROR, RE_FRAMEWORK_ERROR, RE_INIT_ERROR, RE_RUNTIME_ERROR
 
Constructor Summary
ETillCassetteException()
          Constructs an ETillCassetteException.
ETillCassetteException(Cassette aCassette)
          Constructs an ETillCassetteException for the specified Cassette object.
ETillCassetteException(int code)
          Constructs an ETillCassetteException with the specified secondary error code.
ETillCassetteException(int code, Cassette aCassette)
          Constructs an ETillCassetteException with the specified secondary error code for the specified Cassette object.
ETillCassetteException(String message)
          Constructs an ETillCassetteException with text to be displayed at the console.
ETillCassetteException(String message, Cassette aCassette)
          Constructs an ETillCassetteException with text to be displayed at the console for the specified Cassette object.
ETillCassetteException(String message, int code)
          Constructs an ETillCassetteException with the specified text and secondary error code.
ETillCassetteException(String message, int code, Cassette aCassette)
          Constructs an ETillCassetteException with the specified text and secondary error code for the specified Cassette object.
 
Method Summary
 Cassette getCassette()
          Returns the Cassette object for the cassette that's thrown this exception.
 int getPrimaryErrorCode()
          Returns the system termination code representing this exception.
 
Methods inherited from class com.ibm.etill.framework.log.ETillRuntimeException
getSecondaryErrorCode
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ETillCassetteException

public ETillCassetteException(String message)
Constructs an ETillCassetteException with text to be displayed at the console.
Parameters:
message - a String containing the text to display.

ETillCassetteException

public ETillCassetteException(String message,
                              Cassette aCassette)
Constructs an ETillCassetteException with text to be displayed at the console for the specified Cassette object.
Parameters:
message - a String containing the text to display.
aCassette - the Cassette object for the cassette which experienced the error.

ETillCassetteException

public ETillCassetteException(int code)
Constructs an ETillCassetteException with the specified secondary error code. If this exception object is thrown, the text "secondary error code = nn" will be displayed at the console.
Parameters:
code - an int containing the secondary error code.

ETillCassetteException

public ETillCassetteException(int code,
                              Cassette aCassette)
Constructs an ETillCassetteException with the specified secondary error code for the specified Cassette object. If this exception object is thrown, the text "secondary error code = nn" will be displayed at the console.
Parameters:
code - an int containing the secondary error code.
aCassette - the Cassette object for the cassette which experienced the error.

ETillCassetteException

public ETillCassetteException()
Constructs an ETillCassetteException. If this exception object is thrown, the text "violated internal assertion" will be displayed at the console.

ETillCassetteException

public ETillCassetteException(Cassette aCassette)
Constructs an ETillCassetteException for the specified Cassette object. If this exception object is thrown, the text "cassette = aCassette.toString()" will be displayed at the console.
Parameters:
aCassette - the Cassette object for the cassette which experienced the error.

ETillCassetteException

public ETillCassetteException(String message,
                              int code)
Constructs an ETillCassetteException with the specified text and secondary error code.
Parameters:
message - a String containing the text to display.
code - an int containing the secondary error code.

ETillCassetteException

public ETillCassetteException(String message,
                              int code,
                              Cassette aCassette)
Constructs an ETillCassetteException with the specified text and secondary error code for the specified Cassette object.
Parameters:
message - a String containing the text to display.
code - an int containing the secondary error code.
aCassette - the Cassette object for the cassette which experienced the error.
Method Detail

getPrimaryErrorCode

public int getPrimaryErrorCode()
Returns the system termination code representing this exception.
Overrides:
getPrimaryErrorCode in class ETillRuntimeException
Returns:
int - the termination code. For instances of this class, RE_CASSETTE_ERROR is always returned.

getCassette

public Cassette getCassette()
Returns the Cassette object for the cassette that's thrown this exception.
Overrides:
getCassette in class ETillRuntimeException
Returns:
Cassette - the Cassette object under which the error occured.