Class StreamingResponseCanceledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

com.soklet.StreamingResponseCanceledException

All Implemented Interfaces:

Serializable

public class StreamingResponseCanceledException
extends IOException

Thrown when a response stream has been canceled.

Author:

Mark Allen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StreamingResponseCanceledException(@NonNull StreamTerminationReason cancelationReason)	Creates an exception with the given cancelation reason.
StreamingResponseCanceledException(@NonNull StreamTerminationReason cancelationReason, @Nullable Throwable cancelationCause)	Creates an exception with the given cancelation reason and cause.

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<Throwable>	getCancelationCause()	The underlying cancelation cause, if available.
@NonNull StreamTerminationReason	getCancelationReason()	The cancelation reason.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

StreamingResponseCanceledException

public StreamingResponseCanceledException(@NonNull StreamTerminationReason cancelationReason)

Creates an exception with the given cancelation reason.

Parameters:

cancelationReason - the cancelation reason

StreamingResponseCanceledException

public StreamingResponseCanceledException(@NonNull StreamTerminationReason cancelationReason,
 @Nullable Throwable cancelationCause)

Creates an exception with the given cancelation reason and cause.

Parameters:

cancelationReason - the cancelation reason

cancelationCause - the underlying cause, or null if unavailable

Method Details

getCancelationReason

public @NonNull StreamTerminationReason getCancelationReason()

The cancelation reason.

Returns:

the cancelation reason

getCancelationCause

public @NonNull Optional<Throwable> getCancelationCause()

The underlying cancelation cause, if available.

Returns:

the underlying cancelation cause