com.github.robtimus.io.stream

Class RandomInputStream.Builder

java.lang.Object

com.github.robtimus.io.stream.RandomInputStream.Builder

Enclosing class:

RandomInputStream

public static final class RandomInputStream.Builder
extends Object

A builder for random input streams.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
RandomInputStream	build() Creates a new random input stream with the settings from this builder.
<R> R	transform(Function<? super RandomInputStream.Builder,? extends R> f) This method allows the application of a function to this builder object.
RandomInputStream.Builder	withLimit(long limit) Specifies the maximum number of bytes to return while reading.
RandomInputStream.Builder	withRandom(Random random) Specifies the random to use.
RandomInputStream.Builder	withRandomLimit(int min, int max) Specifies that a random number should be used for the maximum number of bytes to return while reading.

Methods inherited from class java.lang.Object

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

Method Detail

withRandom

public RandomInputStream.Builder withRandom(Random random)

Specifies the random to use. By default a new SecureRandom will be created.

Parameters:

random - The random to use.

Returns:

This object.

Throws:

NullPointerException - If the given random is null.

withLimit

public RandomInputStream.Builder withLimit(long limit)

Specifies the maximum number of bytes to return while reading. By default there is no limit. Use a negative value to specify no limit.

Calling this method will discard any changes made by withRandomLimit(int, int).

Parameters:

limit - The limit to set.

Returns:

This object.

withRandomLimit

public RandomInputStream.Builder withRandomLimit(int min,
                                                 int max)

Specifies that a random number should be used for the maximum number of bytes to return while reading. By default there is no limit.

Calling this method will cause any changes made by withLimit(long) to be ignored.

Parameters:

min - The minimum allowed limit, inclusive.

max - The maximum allowed limit, exclusive.

Returns:

This object.

Throws:

IllegalArgumentException - If the minimum is negative, or the maximum is not larger than the minimum.

transform

public <R> R transform(Function<? super RandomInputStream.Builder,? extends R> f)

This method allows the application of a function to this builder object.

Any exception thrown by the function will be propagated to the caller.

Type Parameters:

R - The type of the result of the function.

Parameters:

f - The function to apply.

Returns:

The result of applying the function to this builder object.

build

public RandomInputStream build()

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

Returns:

The created random input stream.