com.github.robtimus.io.stream

Class CapturingWriter.Config.Builder

java.lang.Object

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

Enclosing class:

CapturingWriter.Config

public static final class CapturingWriter.Config.Builder
extends Object

A builder for capturing writer configurations.

Author:

Rob Spoor

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

withLimit

public CapturingWriter.Config.Builder withLimit(int limit)

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

Parameters:

limit - The maximum number of characters to capture.

Returns:

This object.

Throws:

IllegalArgumentException - If the given limit is negative.

withExpectedCount

public CapturingWriter.Config.Builder withExpectedCount(int expectedCount)

Sets the expected number of characters that can be written to the wrapped writer. 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 characters that can be written to the wrapped writer, or a negative number if not known.

Returns:

This object.

onDone

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

Sets a callback that will be triggered when reading from built capturing writers is done. This can be because the writer is closed or because it has been explicitly marked as done. A capturing writer 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 CapturingWriter.Config.Builder onLimitReached(Consumer<? super CapturingWriter> callback)

Sets a callback that will be triggered when built capturing writers hit their limit. If a writer 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 CapturingWriter.Config.Builder onError(BiConsumer<? super CapturingWriter,? super IOException> callback)

Sets a callback that will be triggered when an IOException occurs while using built capturing writers. A capturing writer 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 CapturingWriter.Config build()

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

Returns:

The created capturing writer configuration.