com.caplin.jtm.net.udp

Class UDPCommandRemovalException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.caplin.jtm.net.udp.UDPCommandRemovalException

All Implemented Interfaces:

java.io.Serializable

public class UDPCommandRemovalException
extends java.lang.Exception

Thrown when a problem occurs whilst attempting to remove a UDPCommandListener.

See Also:

UDPAccessor.removeUDPCommandListener(java.lang.String, com.caplin.jtm.net.udp.UDPCommandListener), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UDPCommandRemovalException(java.lang.String message, int errorCode) Constructs the UDPCommandRemovalException with the specified message and error code.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Gets the error code that was returned from the UDPAccessor to indicate what the problem was.
java.lang.String	toString() Returns a string that describes the exception, including the message that details what happened and the error code.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UDPCommandRemovalException

public UDPCommandRemovalException(java.lang.String message,
                                  int errorCode)

Constructs the UDPCommandRemovalException with the specified message and error code.

Parameters:

message - A description of what caused the exception.

errorCode - The error code returned from the Transformer.

Method Detail

getErrorCode

public int getErrorCode()

Gets the error code that was returned from the UDPAccessor to indicate what the problem was.

If the error code is -1, then the attempt to remove the listener failed because it has already been removed.

Any other error codes are unexpected.

Returns:

The value of the error code.

toString

public java.lang.String toString()

Returns a string that describes the exception, including the message that details what happened and the error code.

Overrides:

toString in class java.lang.Throwable

Returns:

A string that represents the UDPCommandRemovalException.