Package org.instancio.internal.random

Interface RandomProvider

All Known Implementing Classes:
RandomProviderImpl
public interface RandomProvider
Provides methods for generating random values such as numbers, booleans, characters, and strings.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    alphabetic(int length)
     
    byte
    byteBetween(byte min, byte max)
     
    char
    character()
     
    boolean
    diceRoll(boolean precondition)
     
    double
    doubleBetween(double min, double max)
     
    float
    floatBetween(float min, float max)
     
    <T> T
    from(Collection<T> collection)
    Returns a random element from given collection.
    <T> T
    from(T... array)
    Returns a random element from given array.
    int
    getSeed()
    Returns the seed value used by the random number generator.
    int
    intBetween(int min, int max)
     
    long
    longBetween(long min, long max)
     
    short
    shortBetween(short min, short max)
     
    boolean
    trueOrFalse()
     

  • Method Details

    • getSeed

      int getSeed()
      Returns the seed value used by the random number generator.
      Returns:
      seed value

    • trueOrFalse

      boolean trueOrFalse()
      Returns:
      a random true or false value with a 0.5 probability.

    • diceRoll

      boolean diceRoll(boolean precondition)
      Parameters:
      precondition - required for returning true value
      Returns:
      a random true with 1/6 probability.

    • byteBetween

      byte byteBetween(byte min, byte max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random byte between the min and max, exclusive

    • shortBetween

      short shortBetween(short min, short max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random short between the min and max, exclusive

    • intBetween

      int intBetween(int min, int max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random int between the min and max, exclusive

    • longBetween

      long longBetween(long min, long max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random long between the min and max, exclusive

    • floatBetween

      float floatBetween(float min, float max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random float between the min and max, exclusive

    • doubleBetween

      double doubleBetween(double min, double max)
      Parameters:
      min - lower bound
      max - upper bound (exclusive)
      Returns:
      a random double between the min and max, exclusive

    • character

      char character()
      Returns:
      random uppercase character between A-Z inclusive.

    • alphabetic

      String alphabetic(int length)
      Parameters:
      length - of the string to generate
      Returns:
      random uppercase String with given length

    • from

      <T> T from(T... array)
      Returns a random element from given array.
      Type Parameters:
      T - element type
      Parameters:
      array - to pick a value from
      Returns:
      random element

    • from

      <T> T from(Collection<T> collection)
      Returns a random element from given collection.
      Type Parameters:
      T - element type
      Parameters:
      collection - to pick a value from
      Returns:
      random element