Package org.instancio

Interface Random

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String alphanumeric​(int length)
      Generates a random alphanumeric String comprised of [a-z, A-Z, 0-9].
      char alphanumericCharacter()
      Returns a random alphanumeric character, [a-z, A-Z, 0-9].
      byte byteRange​(byte min, byte max)
      Returns a random byte within the given range.
      char character()
      Returns a random alphabetic character, [a-z, A-Z].
      boolean diceRoll​(boolean precondition)
      Returns true with a 1/6 probability, but only if the precondition is true.
      String digits​(int length)
      Generates a random String comprised of digits [0-9].
      double doubleRange​(double min, double max)
      Returns a random double within the given range.
      float floatRange​(float min, float max)
      Returns a random float within the given range.
      int getSeed()
      Returns the seed value used by the random number generator.
      int intRange​(int min, int max)
      Returns a random int within the given range.
      long longRange​(long min, long max)
      Returns a random long within the given range.
      String lowerCaseAlphabetic​(int length)
      Generates a lower case String comprised of [a-z].
      char lowerCaseCharacter()
      Returns a random lower alphabetic character, [a-z].
      String mixedCaseAlphabetic​(int length)
      Generates a random mixed case String comprised of [a-z, A-Z].
      <T> T oneOf​(Collection<T> collection)
      Returns a random element from the given collection.
      <T> T oneOf​(T... array)
      Returns a random element from the given array.
      short shortRange​(short min, short max)
      Returns a random short within the given range.
      boolean trueOrFalse()
      Returns a random boolean with a 0.5 probability.
      String upperCaseAlphabetic​(int length)
      Generates a random upper case String comprised of [A-Z].
      char upperCaseCharacter()
      Returns a random upper alphabetic character, [A-Z].

    • Method Detail

      • getSeed

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

      • trueOrFalse

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

      • diceRoll

        boolean diceRoll​(boolean precondition)
        Returns true with a 1/6 probability, but only if the precondition is true.
        Parameters:
        precondition - required for returning true value
        Returns:
        a random true with 1/6 probability.

      • byteRange

        byte byteRange​(byte min,
               byte max)
        Returns a random byte within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random byte between the min and max, inclusive

      • shortRange

        short shortRange​(short min,
                 short max)
        Returns a random short within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random short between the min and max, inclusive

      • intRange

        int intRange​(int min,
             int max)
        Returns a random int within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random int between the min and max, inclusive

      • longRange

        long longRange​(long min,
               long max)
        Returns a random long within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random long between the min and max, inclusive

      • floatRange

        float floatRange​(float min,
                 float max)
        Returns a random float within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random float between the min and max, inclusive

      • doubleRange

        double doubleRange​(double min,
                   double max)
        Returns a random double within the given range.
        Parameters:
        min - lower bound
        max - upper bound (inclusive)
        Returns:
        a random double between the min and max, inclusive

      • character

        char character()
        Returns a random alphabetic character, [a-z, A-Z].
        Returns:
        random character, either lower or upper case

      • alphanumericCharacter

        char alphanumericCharacter()
        Returns a random alphanumeric character, [a-z, A-Z, 0-9].
        Returns:
        an alphanumeric character

      • lowerCaseCharacter

        char lowerCaseCharacter()
        Returns a random lower alphabetic character, [a-z].
        Returns:
        random lower character

      • upperCaseCharacter

        char upperCaseCharacter()
        Returns a random upper alphabetic character, [A-Z].
        Returns:
        random uppercase character

      • lowerCaseAlphabetic

        String lowerCaseAlphabetic​(int length)
        Generates a lower case String comprised of [a-z].
        Parameters:
        length - of a string to generate
        Returns:
        random lower case String with given length

      • upperCaseAlphabetic

        String upperCaseAlphabetic​(int length)
        Generates a random upper case String comprised of [A-Z].
        Parameters:
        length - of a string to generate
        Returns:
        random upper case String with given length

      • mixedCaseAlphabetic

        String mixedCaseAlphabetic​(int length)
        Generates a random mixed case String comprised of [a-z, A-Z].
        Parameters:
        length - of a string to generate
        Returns:
        random mixed case String with given length

      • alphanumeric

        String alphanumeric​(int length)
        Generates a random alphanumeric String comprised of [a-z, A-Z, 0-9].
        Parameters:
        length - of a string to generate
        Returns:
        random alphanumeric String with given length

      • digits

        String digits​(int length)
        Generates a random String comprised of digits [0-9].
        Parameters:
        length - of a string to generate
        Returns:
        random String comprised of digits with given length

      • oneOf

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

      • oneOf

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