Class StreamTermination

java.lang.Object

com.soklet.StreamTermination

@ThreadSafe
public final class StreamTermination
extends Object

Immutable details describing why and when a stream terminated.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamTermination.Builder	Builder used to construct instances of StreamTermination.
static final class	StreamTermination.Copier	Mutable copier seeded with an existing StreamTermination.

Method Summary

Modifier and Type	Method	Description
@NonNull StreamTermination.Copier	copy()	Vends a mutable copier seeded with this instance's data, suitable for building new instances.
boolean	equals(@Nullable Object object)
@NonNull Optional<Throwable>	getCause()	The underlying termination cause, if available.
@NonNull Duration	getDuration()	How long the stream existed.
@NonNull StreamTerminationReason	getReason()	Why the stream terminated.
int	hashCode()
@NonNull String	toString()
static @NonNull StreamTermination.Builder	with(@NonNull StreamTerminationReason reason, @NonNull Duration duration)	Acquires a builder for StreamTermination instances.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

with

public static @NonNull StreamTermination.Builder with(@NonNull StreamTerminationReason reason,
 @NonNull Duration duration)

Acquires a builder for StreamTermination instances.

Parameters:

reason - why the stream terminated

duration - how long the stream existed

Returns:

the builder

toString

public @NonNull String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getReason

public @NonNull StreamTerminationReason getReason()

Why the stream terminated.

Returns:

the termination reason

getDuration

public @NonNull Duration getDuration()

How long the stream existed.

Returns:

the stream duration

getCause

public @NonNull Optional<Throwable> getCause()

The underlying termination cause, if available.

Returns:

the underlying cause, or Optional.empty() if unavailable

copy

public @NonNull StreamTermination.Copier copy()

Vends a mutable copier seeded with this instance's data, suitable for building new instances.

Returns:

a copier for this instance