Extension (Team33 Randomization Library - Edition "mimas" 1.13.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.

Deprecated.
Further development is discontinued and this package/module may be removed in a future release. Successor edition is the module random-tarvos.
```
@Deprecated
 @FunctionalInterface
public interface Extension
```
Represents an extension of a random generator that defines (additional) 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 nextBits(int). The latter is the only method without a default implementation.
This interface is primarily intended to extend a derivation of Random with basic methods, example:
```
 import de.team33.patterns.random.mimas.Extension;

 import java.math.BigInteger;
 import java.util.Random;

 public class XRandom extends Random implements Extension {

     @Override
     public final BigInteger nextBits(final int numBits) {
         return new BigInteger(numBits, this);
     }
 }
 
```
In such a use case, some of the default implementations will be overwritten by existing implementations from Random.
However, it can also be used in other ways. In particular, deterministic implementations are also conceivable.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default BigInteger`	`nextBigInteger(BigInteger bound)` Deprecated. Returns a `BigInteger` value between ZERO (incl.) and `bound` (excl.).
`default BigInteger`	`nextBigInteger(BigInteger min, BigInteger bound)` Deprecated. Returns a `BigInteger` value between `min` (incl.) and `bound` (excl.).
`BigInteger`	`nextBits(int numBits)` Deprecated. Returns any non-negative `BigInteger` representing a sequence of significant bits of a given length.
`default boolean`	`nextBoolean()` Deprecated. Returns any `boolean` value.
`default byte`	`nextByte()` Deprecated. Returns any `byte` value.
`default char`	`nextChar(String characters)` Deprecated. Returns any `char` value of the given `characters`.
`default double`	`nextDouble()` Deprecated. Returns a `double` value between zero (incl.) and one (excl.).
`default float`	`nextFloat()` Deprecated. Returns a `float` value between zero (incl.) and one (excl.).
`default int`	`nextInt()` Deprecated. Returns any `int` value.
`default int`	`nextInt(int bound)` Deprecated. Returns an `int` value between `zero` (incl.) and `bound` (excl.).
`default int`	`nextInt(int min, int bound)` Deprecated. Returns an `int` value between `min` (incl.) and `bound` (excl.).
`default long`	`nextLong()` Deprecated. Returns any `long` value.
`default long`	`nextLong(long bound)` Deprecated. Returns any `long` value between `zero` (incl.) and `bound` (excl.).
`default long`	`nextLong(long min, long bound)` Deprecated. Returns any `long` value between `min` (incl.) and `bound` (excl.).
`default <T extends Enum<T>> T`	`nextOf(Class<T> enumClass)` Deprecated. Returns one of the given `enum` `values`.
`default <T> T`	`nextOf(T... values)` Deprecated. Returns one of the given `values`.
`default short`	`nextShort()` Deprecated. Returns any `short` value.
`default String`	`nextString(int length, String characters)` Deprecated. Returns a `String` with the given `length` consisting of the given `characters`.

- Method Detail
  - nextBits
```
BigInteger nextBits(int numBits)
```
    Deprecated.
    
    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 a random value within the defined bounds, with each possible value being equally probable.
  - nextBoolean
```
default boolean nextBoolean()
```
    Deprecated.
    
    Returns any boolean value.
    The default implementation depends on the implementation of nextBits(int).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextBoolean().
  - nextByte
```
default byte nextByte()
```
    Deprecated.
    
    Returns any byte value.
    The default implementation depends on the implementation of nextBits(int).
  - nextShort
```
default short nextShort()
```
    Deprecated.
    
    Returns any short value.
    The default implementation depends on the implementation of nextBits(int).
  - nextInt
```
default int nextInt()
```
    Deprecated.
    
    Returns any int value.
    The default implementation depends on the implementation of nextBits(int).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextInt().
  - nextInt
```
default int nextInt(int bound)
```
    Deprecated.
    
    Returns an int value between zero (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBigInteger(BigInteger).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextInt(int).
  - nextInt
```
default int nextInt(int min,
                    int bound)
```
    Deprecated.
    
    Returns an int value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBigInteger(BigInteger, BigInteger).
  - nextLong
```
default long nextLong()
```
    Deprecated.
    
    Returns any long value.
    The default implementation depends on the implementation of nextBits(int).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextLong().
  - nextLong
```
default long nextLong(long bound)
```
    Deprecated.
    
    Returns any long value between zero (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBigInteger(BigInteger).
  - nextLong
```
default long nextLong(long min,
                      long bound)
```
    Deprecated.
    
    Returns any long value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBigInteger(BigInteger, BigInteger).
  - nextFloat
```
default float nextFloat()
```
    Deprecated.
    
    Returns a float value between zero (incl.) and one (excl.).
    The default implementation depends on the implementation of nextBits(int).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextFloat().
  - nextDouble
```
default double nextDouble()
```
    Deprecated.
    
    Returns a double value between zero (incl.) and one (excl.).
    The default implementation depends on the implementation of nextBits(int).
    When used as extension of a Random derivation, this method will (at least) be overridden by Random.nextDouble().
  - nextChar
```
default char nextChar(String characters)
```
    Deprecated.
    
    Returns any char value of the given characters.
    The default implementation depends on the implementation of nextInt(int).
    
    Parameters:
    
    characters - A String made up of the characters that are a possible result.
  - nextString
```
default String nextString(int length,
                          String characters)
```
    Deprecated.
    
    Returns a String with the given length consisting of the given characters.
    The default implementation depends on the implementation of nextInt(int).
    
    Parameters:
    
    length - The length of the resulting string.
    
    characters - A string made up of the characters that make up a possible result.
  - nextBigInteger
```
default BigInteger nextBigInteger(BigInteger bound)
```
    Deprecated.
    
    Returns a BigInteger value between ZERO (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBits(int).
  - nextBigInteger
```
default BigInteger nextBigInteger(BigInteger min,
                                  BigInteger bound)
```
    Deprecated.
    
    Returns a BigInteger value between min (incl.) and bound (excl.).
    The default implementation depends on the implementation of nextBigInteger(BigInteger).
  - nextOf
```
default <T> T nextOf(T... values)
```
    Deprecated.
    
    Returns one of the given values.
    The default implementation depends on the implementation of nextInt(int).
  - nextOf
```
default <T extends Enum<T>> T nextOf(Class<T> enumClass)
```
    Deprecated.
    
    Returns one of the given enum values.
    The default implementation depends on the implementation of nextOf(Object[]).

Interface Extension

Method Summary

Method Detail

nextBits

nextBoolean

nextByte

nextShort

nextInt

nextInt

nextInt

nextLong

nextLong

nextLong

nextFloat

nextDouble

nextChar

nextString

nextBigInteger

nextBigInteger

nextOf

nextOf