com.carrotsearch.randomizedtesting.generators

Class StringGenerator

java.lang.Object

com.carrotsearch.randomizedtesting.generators.StringGenerator

Direct Known Subclasses:

CodepointSetGenerator, RealisticUnicodeGenerator, UnicodeGenerator

public abstract class StringGenerator
extends java.lang.Object

A StringGenerator generates random strings composed of characters. What these characters are and their distribution depends on a subclass.

See Also:

String

Constructor Summary

Constructors

Constructor and Description
StringGenerator()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	ofCodePointsLength(java.util.Random r, int minCodePoints, int maxCodePoints)
abstract java.lang.String	ofCodeUnitsLength(java.util.Random r, int minCodeUnits, int maxCodeUnits)
java.lang.String	ofStringLength(java.util.Random r, int minCodeUnits, int maxCodeUnits) An alias for ofCodeUnitsLength(Random, int, int).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringGenerator

public StringGenerator()

Method Detail

ofStringLength

public java.lang.String ofStringLength(java.util.Random r,
                                       int minCodeUnits,
                                       int maxCodeUnits)

An alias for ofCodeUnitsLength(Random, int, int).

ofCodeUnitsLength

public abstract java.lang.String ofCodeUnitsLength(java.util.Random r,
                                                   int minCodeUnits,
                                                   int maxCodeUnits)

Parameters:

minCodeUnits - Minimum number of code units (inclusive).

maxCodeUnits - Maximum number of code units (inclusive).

Returns:

Returns a string of variable length between minCodeUnits (inclusive) and maxCodeUnits (inclusive) length. Code units are essentially an equivalent of char type, see String class for explanation.

Throws:

java.lang.IllegalArgumentException - Thrown if the generator cannot emit random string of the given unit length. For example a generator emitting only extended unicodeGenerator plane characters (encoded as surrogate pairs) will not be able to emit an odd number of code units.

ofCodePointsLength

public abstract java.lang.String ofCodePointsLength(java.util.Random r,
                                                    int minCodePoints,
                                                    int maxCodePoints)

Parameters:

minCodePoints - Minimum number of code points (inclusive).

maxCodePoints - Maximum number of code points (inclusive).

Returns:

Returns a string of variable length between minCodePoints (inclusive) and maxCodePoints (inclusive) length. Code points are full unicodeGenerator codepoints or an equivalent of int type, see String class for explanation. The returned String.length() may exceed maxCodeUnits because certain code points may be encoded as surrogate pairs.