com.opendxl.streaming.client.exception

Class StopError

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.opendxl.streaming.client.exception.StopError

All Implemented Interfaces:

java.io.Serializable

public class StopError
extends java.lang.Exception

Exception raised for an operation which is interrupted due to the channel being stopped.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopError(java.lang.String message)
StopError(java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApi() Gets the Channel method name in which the StopError occurred.
void	setApi(java.lang.String api) Sets the Channel method name in which the StopError occurred.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StopError

public StopError(java.lang.String message,
                 java.lang.Throwable cause)

Parameters:

message - error description

cause - if StopError is thrown as consequence of another exception. If StopError is not caused by another exception, then it is set to null.

StopError

public StopError(java.lang.String message)

Parameters:

message - error description

Method Detail

getApi

public java.lang.String getApi()

Gets the Channel method name in which the StopError occurred.

Returns:

Channel API name, e.g.: create, subscribe, consume, commit, run

setApi

public void setApi(java.lang.String api)

Sets the Channel method name in which the StopError occurred.

Parameters:

api - the Channel method name, e.g.: create, subscribe, consume, commit, run