net.joala.data.random

Interface RandomStringProvider

All Superinterfaces:

DataProvider<String>, RandomDataProvider<String>

All Known Implementing Classes:

DefaultRandomStringProvider

public interface RandomStringProvider
extends RandomDataProvider<String>

Provides random strings, typically of some minimum and maximum length and with specified types of characters contained.

Since:

9/17/12

Method Summary

Methods

Modifier and Type	Method and Description
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.
RandomStringProvider	type(RandomStringType type) Specify the type of characters to create.

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

fixate

Methods inherited from interface net.joala.data.DataProvider

get

Method Detail

length

@Nonnull
RandomStringProvider length(@Nonnegative
                                  int len)

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

Parameters:

len - the length of the strings to create

Returns:

self-reference

maxLength

@Nonnull
RandomStringProvider maxLength(@Nonnegative
                                     int len)

Specify the maximum length of the strings to return.

Parameters:

len - maximum length of strings

Returns:

self-reference

minLength

@Nonnull
RandomStringProvider minLength(@Nonnegative
                                     int len)

Specify the minimum length of the strings to return.

Parameters:

len - minimum length of strings

Returns:

self-reference

type

@Nonnull
RandomStringProvider type(@Nonnull
                                RandomStringType type)

Specify the type of characters to create.

Parameters:

type - character type

Returns:

self-reference

prefix

@Nonnull
RandomStringProvider prefix(@Nullable
                                  String prefix)

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.

Parameters:

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

Returns:

self-reference

postfix

@Nonnull
RandomStringProvider postfix(@Nullable
                                   String postfix)

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.

Parameters:

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

Returns:

self-reference