com.github.robtimus.io.stream

Class CapturingOutputStream.Config.Builder

java.lang.Object

com.github.robtimus.io.stream.CapturingOutputStream.Config.Builder

Enclosing class:

CapturingOutputStream.Config

public static final class CapturingOutputStream.Config.Builder
extends Object

A builder for capturing output stream configurations.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
CapturingOutputStream.Config	build() Creates a new capturing output stream configuration with the settings from this builder.
CapturingOutputStream.Config.Builder	onDone(Consumer<? super CapturingOutputStream> callback) Sets a callback that will be triggered when reading from built capturing output streams is done.
CapturingOutputStream.Config.Builder	onError(BiConsumer<? super CapturingOutputStream,? super IOException> callback) Sets a callback that will be triggered when an IOException occurs while using built capturing output streams.
CapturingOutputStream.Config.Builder	onLimitReached(Consumer<? super CapturingOutputStream> callback) Sets a callback that will be triggered when built capturing output streams hit their limit.
CapturingOutputStream.Config.Builder	withExpectedCount(int expectedCount) Sets the expected number of bytes that can be written to the wrapped output stream.
CapturingOutputStream.Config.Builder	withLimit(int limit) Sets the maximum number of bytes to capture.

Methods inherited from class java.lang.Object

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

Method Detail

withLimit

public CapturingOutputStream.Config.Builder withLimit(int limit)

Sets the maximum number of bytes to capture. The default value is Integer.MAX_VALUE.

Parameters:

limit - The maximum number of bytes to capture.

Returns:

This object.

Throws:

IllegalArgumentException - If the given limit is negative.

withExpectedCount

public CapturingOutputStream.Config.Builder withExpectedCount(int expectedCount)

Sets the expected number of bytes that can be written to the wrapped output stream. This can be used for performance reasons; if this is set then the capture buffer will be pre-allocated. The default value is -1.

Parameters:

expectedCount - The expected number of bytes that can be written to the wrapped output stream, or a negative number if not known.

Returns:

This object.

onDone

public CapturingOutputStream.Config.Builder onDone(Consumer<? super CapturingOutputStream> callback)

Sets a callback that will be triggered when reading from built capturing output streams is done. This can be because the output stream is closed or because it has been explicitly marked as done. A capturing output stream will only trigger its callback once.

Parameters:

callback - The callback to set.

Returns:

This object.

Throws:

NullPointerException - If the given callback is null.

onLimitReached

public CapturingOutputStream.Config.Builder onLimitReached(Consumer<? super CapturingOutputStream> callback)

Sets a callback that will be triggered when built capturing output streams hit their limit. If an output stream never reaches its limit its callback will never be called.

Parameters:

callback - The callback to set.

Returns:

This object.

Throws:

NullPointerException - If the given callback is null.

onError

public CapturingOutputStream.Config.Builder onError(BiConsumer<? super CapturingOutputStream,? super IOException> callback)

Sets a callback that will be triggered when an IOException occurs while using built capturing output streams. A capturing output stream can trigger its error callback multiple times.

Parameters:

callback - The callback to set.

Returns:

This object.

Throws:

NullPointerException - If the given callback is null.

build

public CapturingOutputStream.Config build()

Creates a new capturing output stream configuration with the settings from this builder.

Returns:

The created capturing output stream configuration.