com.github.robtimus.io.stream

Class RandomReader

java.lang.Object

java.io.Reader

com.github.robtimus.io.stream.RandomReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class RandomReader
extends Reader

A reader that will return random characters. This reader 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	RandomReader.Builder A builder for random readers.

Field Summary

Fields inherited from class java.io.Reader

lock

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reader.
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf)
int	read(char[] cbuf, int off, int len)
int	read(CharBuffer target)
boolean	ready()
void	reset()
long	skip(long n)
static RandomReader.Builder	usingAllCharacters() Returns a builder for random readers that can return all possible characters.
static RandomReader.Builder	usingAlphabet(String alphabet) Returns a builder for random readers that can return characters from a specific alphabet.
static RandomReader.Builder	usingDigits() Returns a builder for random readers that can return digits.
static RandomReader.Builder	usingGenerator(ToIntFunction<Random> generator) Returns a builder for random readers that uses a custom generator for characters.
static RandomReader.Builder	usingHex() Returns a builder for random readers that can return characters from 0-9 and a-z.
static RandomReader.Builder	usingHex(boolean upperCase) Returns a builder for random readers that can return characters from 0-9 and a-z or A-Z.
static RandomReader.Builder	usingRange(char start, char end) Returns a builder for random readers that can return characters 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()

Overrides:

read in class Reader

read

public int read(char[] cbuf)

Overrides:

read in class Reader

read

public int read(char[] cbuf,
                int off,
                int len)

Specified by:

read in class Reader

read

public int read(CharBuffer target)

Specified by:

read in interface Readable

Overrides:

read in class Reader

skip

public long skip(long n)

Overrides:

skip in class Reader

ready

public boolean ready()

Overrides:

ready in class Reader

markSupported

public boolean markSupported()

Overrides:

markSupported in class Reader

mark

public void mark(int readAheadLimit)

Overrides:

mark in class Reader

reset

public void reset()

Overrides:

reset in class Reader

close

public void close()

Closes this reader. This will reset the reader to its default settings.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

usingAllCharacters

public static RandomReader.Builder usingAllCharacters()

Returns a builder for random readers that can return all possible characters.

Returns:

A builder for random readers that can return all possible characters.

usingRange

public static RandomReader.Builder usingRange(char start,
                                              char end)

Returns a builder for random readers that can return characters from a specific range.

Parameters:

start - The start of the range, inclusive.

end - The end of the range, inclusive.

Returns:

A builder for random readers that can return characters from the given range.

Throws:

IllegalArgumentException - If start is larger than end.

usingAlphabet

public static RandomReader.Builder usingAlphabet(String alphabet)

Returns a builder for random readers that can return characters from a specific alphabet.

Parameters:

alphabet - A string representing the alphabet to use.

Returns:

A builder for random readers that can return characters from the given alphabet.

Throws:

NullPointerException - If the given alphabet is null.

IllegalArgumentException - If the given alphabet is empty.

usingHex

public static RandomReader.Builder usingHex()

Returns a builder for random readers that can return characters from 0-9 and a-z.

Returns:

A builder for random readers that can return characters from 0-9 and a-z.

usingHex

public static RandomReader.Builder usingHex(boolean upperCase)

Returns a builder for random readers that can return characters from 0-9 and a-z or A-Z.

Parameters:

upperCase - true to use A-Z, or false to use a-z.

Returns:

A builder for random readers that can return characters from 0-9 and a-z or A-Z.

usingDigits

public static RandomReader.Builder usingDigits()

Returns a builder for random readers that can return digits.

Returns:

A builder for random readers that can return digits.

usingGenerator

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

Returns a builder for random readers that uses a custom generator for characters. For each generated value, only the 16 low-order bits are used; the 16 high-order bits are ignored.

Parameters:

generator - The generator to use.

Returns:

A builder for random readers that uses the given custom generator.

Throws:

NullPointerException - If the given custom generator is null.