com.github.robtimus.io.stream

Class CapturingInputStream.Config.Builder

java.lang.Object

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

Enclosing class:

CapturingInputStream.Config

public static final class CapturingInputStream.Config.Builder
extends Object

A builder for capturing input stream configurations.

Author:

Rob Spoor

Method Summary

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

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

Returns:

This object.

doneAfter

public CapturingInputStream.Config.Builder doneAfter(long count)

Sets the number of bytes after which built capturing input streams 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 bytes after which to consider built capturing input streams as done.

Returns:

This object.

Throws:

IllegalArgumentException - If the given number of bytes is negative.

onDone

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

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

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

In case a capturing input stream has reached its limit and is then CapturingInputStream.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 CapturingInputStream.Config.Builder onError(BiConsumer<? super CapturingInputStream,? super IOException> callback)

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

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

Returns:

The created capturing input stream configuration.