Generator (Team33 Arbitrary Library - Edition "mimas" 1.19.0 API)

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Generator
```
A utility interface: represents an interface of a basic arbitrary generator that defines methods for primitive values as well as values of some other basic types, including enum types, String and BigInteger.
Most methods provide a default implementation that (directly or indirectly) uses anyBits(int). The latter is the only method without a default implementation.

See Also:

package

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default BigInteger`	`anyBigInteger(BigInteger bound)` Returns a `BigInteger` value between `BigInteger.ZERO` (incl.) and `bound` (excl.).
`default BigInteger`	`anyBigInteger(BigInteger min, BigInteger bound)` Returns a `BigInteger` value between `min` (incl.) and `bound` (excl.).
`BigInteger`	`anyBits(int numBits)` Returns any non-negative `BigInteger` representing a sequence of significant bits of a given length.
`default boolean`	`anyBoolean()` Returns any `boolean` value.
`default byte`	`anyByte()` Returns any `byte` value.
`default char`	`anyChar(String characters)` Returns any `char` value of the given `characters`.
`default double`	`anyDouble()` Returns a `double` value between zero (incl.) and one (excl.).
`default float`	`anyFloat()` Returns a `float` value between zero (incl.) and one (excl.).
`default int`	`anyInt()` Returns any `int` value.
`default int`	`anyInt(int bound)` Returns an `int` value between `zero` (incl.) and `bound` (excl.).
`default int`	`anyInt(int min, int bound)` Returns an `int` value between `min` (incl.) and `bound` (excl.).
`default long`	`anyLong()` Returns any `long` value.
`default long`	`anyLong(long bound)` Returns any `long` value between `zero` (incl.) and `bound` (excl.).
`default long`	`anyLong(long min, long bound)` Returns any `long` value between `min` (incl.) and `bound` (excl.).
`default <T extends Enum<T>> T`	`anyOf(Class<T> enumClass)` Returns one of the given `enum` `values`.
`default <T> T`	`anyOf(T... values)` Returns one of the given `values`.
`default short`	`anyShort()` Returns any `short` value.
`default String`	`anyString(int length, String characters)` Returns a `String` with the given `length` consisting of the given `characters`.
`static Generator`	`simple()` Provides a new `Generator` using a new `Random`.
`static Generator`	`simple(Random random)` Provides a new `Generator` using a given `Random`.

- Method Detail
  - simple
```
static Generator simple()
```
    Provides a new Generator using a new Random.
  - simple
```
static Generator simple(Random random)
```
    Provides a new Generator using a given Random.
  - anyBits
```
BigInteger anyBits(int numBits)
```
    Returns any non-negative BigInteger representing a sequence of significant bits of a given length. In other words, the result is any value between zero (inclusive) and 2^length (exclusive).
    A typical implementation will return an arbitrary value within the defined bounds, with each possible value being equally probable.
  - anyBoolean
```
default boolean anyBoolean()
```
    Returns any boolean value.
    The default implementation depends on the implementation of anyBits(int).
  - anyByte
```
default byte anyByte()
```
    Returns any byte value.
    The default implementation depends on the implementation of anyBits(int).
  - anyShort
```
default short anyShort()
```
    Returns any short value.
    The default implementation depends on the implementation of anyBits(int).
  - anyInt
```
default int anyInt()
```
    Returns any int value.
    The default implementation depends on the implementation of anyBits(int).
  - anyInt
```
default int anyInt(int bound)
```
    Returns an int value between zero (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBigInteger(BigInteger).
  - anyInt
```
default int anyInt(int min,
                   int bound)
```
    Returns an int value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBigInteger(BigInteger, BigInteger).
  - anyLong
```
default long anyLong()
```
    Returns any long value.
    The default implementation depends on the implementation of anyBits(int).
  - anyLong
```
default long anyLong(long bound)
```
    Returns any long value between zero (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBigInteger(BigInteger).
  - anyLong
```
default long anyLong(long min,
                     long bound)
```
    Returns any long value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBigInteger(BigInteger, BigInteger).
  - anyFloat
```
default float anyFloat()
```
    Returns a float value between zero (incl.) and one (excl.).
    The default implementation depends on the implementation of anyBits(int).
  - anyDouble
```
default double anyDouble()
```
    Returns a double value between zero (incl.) and one (excl.).
    The default implementation depends on the implementation of anyBits(int).
  - anyChar
```
default char anyChar(String characters)
```
    Returns any char value of the given characters.
    The default implementation depends on the implementation of anyInt(int).
    
    Parameters:
    
    characters - A String made up of the characters that are a possible result.
  - anyString
```
default String anyString(int length,
                         String characters)
```
    Returns a String with the given length consisting of the given characters.
    The default implementation depends on the implementation of anyInt(int).
    
    Parameters:
    
    length - The length of the resulting string.
    
    characters - A string made up of the characters that make up a possible result.
  - anyBigInteger
```
default BigInteger anyBigInteger(BigInteger bound)
```
    Returns a BigInteger value between BigInteger.ZERO (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBits(int).
  - anyBigInteger
```
default BigInteger anyBigInteger(BigInteger min,
                                 BigInteger bound)
```
    Returns a BigInteger value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of anyBigInteger(BigInteger).
  - anyOf
```
default <T> T anyOf(T... values)
```
    Returns one of the given values.
    The default implementation depends on the implementation of anyInt(int).
  - anyOf
```
default <T extends Enum<T>> T anyOf(Class<T> enumClass)
```
    Returns one of the given enum values.
    The default implementation depends on the implementation of anyOf(Object[]).

Interface Generator

Method Summary

Method Detail

simple

simple

anyBits

anyBoolean

anyByte

anyShort

anyInt

anyInt

anyInt

anyLong

anyLong

anyLong

anyFloat

anyDouble

anyChar

anyString

anyBigInteger

anyBigInteger

anyOf

anyOf