Class StreamTermination.Builder

java.lang.Object

com.soklet.StreamTermination.Builder

Direct Known Subclasses:

StreamTermination.Copier

Enclosing class:

StreamTermination

@NotThreadSafe
public static class StreamTermination.Builder
extends Object

Builder used to construct instances of StreamTermination.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull StreamTermination	build()	Builds a StreamTermination instance.
@NonNull StreamTermination.Builder	cause(@Nullable Throwable cause)	Specifies the underlying termination cause.
@NonNull StreamTermination.Builder	duration(@NonNull Duration duration)	Specifies how long the stream existed.
@NonNull StreamTermination.Builder	reason(@NonNull StreamTerminationReason reason)	Specifies why the stream terminated.

Methods inherited from class Object

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

Method Details

reason

public @NonNull StreamTermination.Builder reason(@NonNull StreamTerminationReason reason)

Specifies why the stream terminated.

Parameters:

reason - the termination reason

Returns:

this builder

duration

public @NonNull StreamTermination.Builder duration(@NonNull Duration duration)

Specifies how long the stream existed.

Parameters:

duration - the stream duration

Returns:

this builder

cause

public @NonNull StreamTermination.Builder cause(@Nullable Throwable cause)

Specifies the underlying termination cause.

Parameters:

cause - the cause, or null if unavailable

Returns:

this builder

build

public @NonNull StreamTermination build()

Builds a StreamTermination instance.

Returns:

the termination details