com.github.robtimus.io.stream

Class CapturingReader.Config.Builder

java.lang.Object

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

Enclosing class:

CapturingReader.Config

public static final class CapturingReader.Config.Builder
extends Object

A builder for capturing reader configurations.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
CapturingReader.Config	build() Creates a new capturing reader configuration with the settings from this builder.
CapturingReader.Config.Builder	doneAfter(long count) Sets the number of characters after which built capturing readers are considered to be done.
CapturingReader.Config.Builder	onDone(Consumer<? super CapturingReader> callback) Sets a callback that will be triggered when reading from built capturing readers is done.
CapturingReader.Config.Builder	onError(BiConsumer<? super CapturingReader,? super IOException> callback) Sets a callback that will be triggered when an IOException occurs while using built capturing readers.
CapturingReader.Config.Builder	onLimitReached(Consumer<? super CapturingReader> callback) Sets a callback that will be triggered when built capturing readers hit their limit.
CapturingReader.Config.Builder	withExpectedCount(int expectedCount) Sets the expected number of characters that can be read from the wrapped reader.
CapturingReader.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 CapturingReader.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 CapturingReader.Config.Builder withExpectedCount(int expectedCount)

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

Returns:

This object.

doneAfter

public CapturingReader.Config.Builder doneAfter(long count)

Sets the number of characters after which built capturing readers are considered to be done. The default is Long.MAX_VALUE.

Some frameworks don't fully consume all content. Instead they stop at a specific point. For instance, some JSON parsers stop reading as soon as the root object's closing closing curly brace is encountered.

Ideally such a framework is configured to consume all content. This method can be used as fallback if that's not possible. For instance, it can be called with an HTTP request's content length.

Parameters:

count - The number of characters after which to consider built capturing readers as done.

Returns:

This object.

Throws:

IllegalArgumentException - If the given number of characters is negative.

onDone

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

Sets a callback that will be triggered when reading from built capturing readers is done. This can be because the reader is consumed or closed, or because the amount set using doneAfter(long) has been reached. A capturing reader 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 CapturingReader.Config.Builder onLimitReached(Consumer<? super CapturingReader> callback)

Sets a callback that will be triggered when built capturing readers hit their limit. If a reader never reaches its limit its callback will never be called.

In case a capturing reader has reached its limit and is then CapturingReader.reset() to before its limit, it will not call its callback again.

Parameters:

callback - The callback to set.

Returns:

This object.

Throws:

NullPointerException - If the given callback is null.

onError

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

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

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

Returns:

The created capturing reader configuration.