com.github.robtimus.io.stream

Class RandomInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.RandomInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RandomInputStream
extends InputStream

An input stream that will return random bytes. This input stream supports mark(int) and reset(). It comes with a default mark at the start of the stream, which means that reset() can be called at any time.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RandomInputStream.Builder A builder for random input streams.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closes this input stream.
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(byte[] cbuf)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
static RandomInputStream.Builder	usingAllBytes() Returns a builder for random input streams that can return all possible bytes.
static RandomInputStream.Builder	usingGenerator(ToIntFunction<Random> generator) Returns a builder for random input streams that uses a custom generator for bytes.
static RandomInputStream.Builder	usingRange(int start, int end) Returns a builder for random input streams that can return bytes from a specific range.
static RandomInputStream.Builder	usingRangeFrom(int start) Returns a builder for random input streams that can return bytes from a specific range.
static RandomInputStream.Builder	usingRangeUntil(int end) Returns a builder for random input streams that can return bytes from a specific range.

Methods inherited from class java.lang.Object

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

Method Detail

read

public int read()

Specified by:

read in class InputStream

read

public int read(byte[] cbuf)

Overrides:

read in class InputStream

read

public int read(byte[] b,
                int off,
                int len)

Overrides:

read in class InputStream

skip

public long skip(long n)

Overrides:

skip in class InputStream

available

public int available()

Overrides:

available in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readAheadLimit)

Overrides:

mark in class InputStream

reset

public void reset()

Overrides:

reset in class InputStream

close

public void close()

Closes this input stream. This will reset the input stream to its default settings.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

usingAllBytes

public static RandomInputStream.Builder usingAllBytes()

Returns a builder for random input streams that can return all possible bytes.

Returns:

A builder for random input streams that can return all possible bytes.

usingRange

public static RandomInputStream.Builder usingRange(int start,
                                                   int end)

Returns a builder for random input streams that can return bytes from a specific range. For the start and end of the range, only the 8 low-order bits are used; the 24 high-order bits are ignored. It's therefore advised to use unsigned values between 0 and 255 or 0xFF.

Parameters:

start - The start of the range, inclusive.

end - The end of the range, inclusive.

Returns:

A builder for random input streams that can return bytes from the given range.

Throws:

IllegalArgumentException - If start is larger than end.

usingRangeFrom

public static RandomInputStream.Builder usingRangeFrom(int start)

Returns a builder for random input streams that can return bytes from a specific range. This method is equal to usingRange(start, 0xFF).

Parameters:

start - The start of the range, inclusive.

Returns:

A builder for random input streams that can return bytes from the given range.

usingRangeUntil

public static RandomInputStream.Builder usingRangeUntil(int end)

Returns a builder for random input streams that can return bytes from a specific range. This method is equal to usingRange(0, end).

Parameters:

end - The end of the range, inclusive.

Returns:

A builder for random input streams that can return bytes from the given range.

usingGenerator

public static RandomInputStream.Builder usingGenerator(ToIntFunction<Random> generator)

Returns a builder for random input streams that uses a custom generator for bytes. For each generated value, only the 8 low-order bits are used; the 24 high-order bits are ignored.

Parameters:

generator - The generator to use.

Returns:

A builder for random input streams that uses the given custom generator.

Throws:

NullPointerException - If the given custom generator is null.