com.sonicsw.stream
Class SonicStreamException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              com.sonicsw.stream.SonicStreamException

All Implemented Interfaces:

java.io.Serializable

public class SonicStreamException
extends java.io.IOException

The exception thrown by methods in the SonicStreams api. It provides the following information:

• The error message associated with the exception.
• The error code associated with the exception. ErrorCodes are defined in SonicStreamConstants.
• A reference to another exception (could be null). This could be a lower level exception or a JMS exception.

See Also:

Serialized Form

Constructor Summary

SonicStreamException(java.lang.String msg, int error)

Method Summary

int	getErrorCode() Gets the error code of the SonicStreamException instance.
java.lang.Exception	getLinkedException() Gets the Exception instance linked to a SonicStreamException instance.
void	setLinkedException(java.lang.Exception exc) Links an Exception instance to a SonicStreamException instance.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SonicStreamException

public SonicStreamException(java.lang.String msg,
                            int error)

Method Detail

getErrorCode

public int getErrorCode()

Gets the error code of the SonicStreamException instance. The set of pre-defined error codes is defined in SonicStreamConstants.

Returns:

error code

See Also:

SonicStreamConstants

setLinkedException

public void setLinkedException(java.lang.Exception exc)

Links an Exception instance to a SonicStreamException instance.

Parameters:

exc - Exception instance to be linked to this SonicStreamException instance

getLinkedException

public java.lang.Exception getLinkedException()

Gets the Exception instance linked to a SonicStreamException instance. Will return null if there is no exception linked to the SonicStreamException instance.

Returns:

Exception instance to linked to SonicStreamException instance; may be null if there is no Exception linked to SonicStreamException