Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.lang.RandomStringUtils
public class RandomStringUtils
extends java.lang.Object
String
s.
Currently private high surrogate characters are ignored.
These are unicode characters that fall between the values 56192 (db80)
and 56319 (dbff) as we don't know how to handle them.
High and low surrogates are correctly dealt with - that is if a
high surrogate is randomly chosen, 55296 (d800) to 56191 (db7f)
then it is followed by a low surrogate. If a low surrogate is chosen,
56320 (dc00) to 57343 (dfff) then it is placed after a randomly
chosen high surrogate.
Constructor Summary | |
|
Method Summary | |
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
public RandomStringUtils()
RandomStringUtils
instances should NOT be constructed in standard programming. Instead, the class should be used asRandomStringUtils.random(5);
. This constructor is public to permit tools that require a JavaBean instance to operate.
public static String random(int count)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of all characters.
- Parameters:
count
- the length of random string to create
- Returns:
- the random string
public static String random(int count, String chars)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of characters specified.
- Parameters:
count
- the length of random string to createchars
- the String containing the set of characters to use, may be null
- Returns:
- the random string
public static String random(int count, boolean letters, boolean numbers)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.
- Parameters:
count
- the length of random string to createletters
- iftrue
, generated string will include alphabetic charactersnumbers
- iftrue
, generated string will include numeric characters
- Returns:
- the random string
public static String random(int count, char[] chars)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of characters specified.
- Parameters:
count
- the length of random string to createchars
- the character array containing the set of characters to use, may be null
- Returns:
- the random string
public static String random(int count, int start, int end, boolean letters, boolean numbers)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.
- Parameters:
count
- the length of random string to createstart
- the position in set of chars to start atend
- the position in set of chars to end beforeletters
- iftrue
, generated string will include alphabetic charactersnumbers
- iftrue
, generated string will include numeric characters
- Returns:
- the random string
public static String random(int count, int start, int end, boolean letters, boolean numbers, char[] chars)
Creates a random string based on a variety of options, using default source of randomness. This method has exactly the same semantics asrandom(int,int,int,boolean,boolean,char[],Random)
, but instead of using an externally supplied source of randomness, it uses the internal staticRandom
instance.
- Parameters:
count
- the length of random string to createstart
- the position in set of chars to start atend
- the position in set of chars to end beforeletters
- only allow letters?numbers
- only allow numbers?chars
- the set of chars to choose randoms from. Ifnull
, then it will use the set of all chars.
- Returns:
- the random string
public static String random(int count, int start, int end, boolean letters, boolean numbers, char[] chars, Random random)
Creates a random string based on a variety of options, using supplied source of randomness. If start and end are both0
, start and end are set to' '
and'z'
, the ASCII printable characters, will be used, unless letters and numbers are bothfalse
, in which case, start and end are set to0
andInteger.MAX_VALUE
. If set is notnull
, characters between start and end are chosen. This method accepts a user-suppliedRandom
instance to use as a source of randomness. By seeding a singleRandom
instance with a fixed seed and using it for each call, the same random sequence of strings can be generated repeatedly and predictably.
- Parameters:
count
- the length of random string to createstart
- the position in set of chars to start atend
- the position in set of chars to end beforeletters
- only allow letters?numbers
- only allow numbers?chars
- the set of chars to choose randoms from. Ifnull
, then it will use the set of all chars.random
- a source of randomness.
- Returns:
- the random string
- Since:
- 2.0
public static String randomAlphabetic(int count)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alphabetic characters.
- Parameters:
count
- the length of random string to create
- Returns:
- the random string
public static String randomAlphanumeric(int count)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of alpha-numeric characters.
- Parameters:
count
- the length of random string to create
- Returns:
- the random string
public static String randomAscii(int count)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of characters whose ASCII value is between32
and126
(inclusive).
- Parameters:
count
- the length of random string to create
- Returns:
- the random string
public static String randomNumeric(int count)
Creates a random string whose length is the number of characters specified. Characters will be chosen from the set of numeric characters.
- Parameters:
count
- the length of random string to create
- Returns:
- the random string