net.joala.data.random

Class DefaultRandomStringProvider

java.lang.Object

net.joala.data.random.AbstractRandomDataProvider<String>

net.joala.data.random.DefaultRandomStringProvider

All Implemented Interfaces:

DataProvider<String>, RandomDataProvider<String>, RandomStringProvider

public class DefaultRandomStringProvider
extends AbstractRandomDataProvider<String>
implements RandomStringProvider

Since:

9/17/12

Constructor Summary

Constructors

Constructor and Description
DefaultRandomStringProvider()
DefaultRandomStringProvider(int defaultLen)
DefaultRandomStringProvider(int defaultMinLen, int defaultMaxLen)
DefaultRandomStringProvider(RandomStringType type)
DefaultRandomStringProvider(RandomStringType type, int defaultLen)
DefaultRandomStringProvider(RandomStringType type, int defaultMinLen, int defaultMaxLen)

Method Summary

Methods

Modifier and Type	Method and Description
String	get() Retrieve a random data.
protected int	getLength()
protected String	getPostfix()
protected String	getPrefix()
protected RandomStringType	getStringType()
RandomStringProvider	length(int len) Specify the exact length of the strings to return.
RandomStringProvider	maxLength(int len) Specify the maximum length of the strings to return.
RandomStringProvider	minLength(int len) Specify the minimum length of the strings to return.
RandomStringProvider	postfix(String postfix) Specify a postfix to attach to the random string.
RandomStringProvider	prefix(String prefix) Specify a prefix to put in front of the random string.
String	toString()
RandomStringProvider	type(RandomStringType type) Specify the type of characters to create.

Methods inherited from class net.joala.data.random.AbstractRandomDataProvider

fixate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.joala.data.random.RandomDataProvider

fixate

Constructor Detail

DefaultRandomStringProvider

public DefaultRandomStringProvider()

DefaultRandomStringProvider

public DefaultRandomStringProvider(@Nonnegative
                           int defaultLen)

DefaultRandomStringProvider

public DefaultRandomStringProvider(@Nonnegative
                           int defaultMinLen,
                           @Nonnegative
                           int defaultMaxLen)

DefaultRandomStringProvider

public DefaultRandomStringProvider(@Nonnull
                           RandomStringType type)

DefaultRandomStringProvider

public DefaultRandomStringProvider(@Nonnull
                           RandomStringType type,
                           @Nonnegative
                           int defaultLen)

DefaultRandomStringProvider

public DefaultRandomStringProvider(@Nonnull
                           RandomStringType type,
                           @Nonnegative
                           int defaultMinLen,
                           @Nonnegative
                           int defaultMaxLen)

Method Detail

get

public String get()
           throws DataProvidingException

Description copied from interface: DataProvider

Retrieve a random data.

Specified by:

get in interface DataProvider<String>

Returns:

random data

Throws:

DataProvidingException - if an error occurred during data generation

getLength

@Nonnegative
protected final int getLength()
                       throws DataProvidingException

Throws:

DataProvidingException

getStringType

@Nonnull
protected final RandomStringType getStringType()

getPostfix

@Nullable
protected final String getPostfix()

getPrefix

@Nullable
protected final String getPrefix()

type

@Nonnull
public final RandomStringProvider type(@Nonnull
                                RandomStringType type)

Description copied from interface: RandomStringProvider

Specify the type of characters to create.

Specified by:

type in interface RandomStringProvider

Parameters:

type - character type

Returns:

self-reference

length

@Nonnull
public final RandomStringProvider length(@Nonnegative
                                  int len)

Description copied from interface: RandomStringProvider

Specify the exact length of the strings to return. Sets maximum and minimum length to the same value.

Specified by:

length in interface RandomStringProvider

Parameters:

len - the length of the strings to create

Returns:

self-reference

maxLength

@Nonnull
public final RandomStringProvider maxLength(@Nonnegative
                                     int len)

Description copied from interface: RandomStringProvider

Specify the maximum length of the strings to return.

Specified by:

maxLength in interface RandomStringProvider

Parameters:

len - maximum length of strings

Returns:

self-reference

minLength

@Nonnull
public final RandomStringProvider minLength(@Nonnegative
                                     int len)

Description copied from interface: RandomStringProvider

Specify the minimum length of the strings to return.

Specified by:

minLength in interface RandomStringProvider

Parameters:

len - minimum length of strings

Returns:

self-reference

postfix

@Nonnull
public RandomStringProvider postfix(@Nullable
                                   String postfix)

Description copied from interface: RandomStringProvider

Specify a postfix to attach to the random string. This is sometimes useful in order to assist assertions to be easy to interpret. The postfix length is subtracted from the total valid length of the generated string. So it must not exceed the maximum length.

Specified by:

postfix in interface RandomStringProvider

Parameters:

postfix - postfix for the string; null or empty string for no postfix

Returns:

self-reference

prefix

@Nonnull
public RandomStringProvider prefix(@Nullable
                                  String prefix)

Description copied from interface: RandomStringProvider

Specify a prefix to put in front of the random string. This is sometimes useful in order to assist assertions to be easy to interpret. The prefix length is subtracted from the total valid length of the generated string. So it must not exceed the maximum length.

Specified by:

prefix in interface RandomStringProvider

Parameters:

prefix - prefix for the string; null or empty string for no prefix

Returns:

self-reference

toString

public String toString()

Overrides:

toString in class Object