de.slothsoft.random.types

Class PostalCodeRandomField

java.lang.Object

de.slothsoft.random.types.PostalCodeRandomField

All Implemented Interfaces:

RandomField

public class PostalCodeRandomField
extends Object
implements RandomField

A RandomField representing a String that should look like a postal code. See list of postal codes.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DIGIT Key that can be used by the pattern to display a single digit.
static String	KEY_LETTER Key that can be used by the pattern to display a single letter.
static String	PATTERN_CANADA Pattern used in Canada, e.g.
static String	PATTERN_GERMANY Pattern used in Germany, e.g.
static String	PATTERN_US Pattern used in the US, e.g.

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
PostalCodeRandomField() Default constructor.

Method Summary

Modifier and Type	Method and Description
double	getNullProbability() Returns the probability for this field returning null.
String	getPattern() Returns the pattern with keys that get replaced during nextValue().
String	nextValue() Returns a random value.
PostalCodeRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
PostalCodeRandomField	pattern(String newPattern) Sets the pattern with keys that get replaced during nextValue().
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.
void	setPattern(String pattern) Sets the pattern with keys that get replaced during nextValue().

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.slothsoft.random.RandomField

init

Field Detail

KEY_DIGIT

public static final String KEY_DIGIT

Key that can be used by the pattern to display a single digit.

See Also:

Constant Field Values

KEY_LETTER

public static final String KEY_LETTER

Key that can be used by the pattern to display a single letter.

See Also:

Constant Field Values

PATTERN_GERMANY

public static final String PATTERN_GERMANY

Pattern used in Germany, e.g. "01109".

See Also:

Constant Field Values

PATTERN_US

public static final String PATTERN_US

Pattern used in the US, e.g. "12345-6789".

See Also:

Constant Field Values

PATTERN_CANADA

public static final String PATTERN_CANADA

Pattern used in Canada, e.g. "A0B 1C2".

See Also:

Constant Field Values

Constructor Detail

PostalCodeRandomField

public PostalCodeRandomField()

Default constructor.

Method Detail

nextValue

public String nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Returns:

a random value

getPattern

public String getPattern()

Returns the pattern with keys that get replaced during nextValue(). Known keys are:

• KEY_DIGIT
• KEY_LETTER

Returns:

the pattern

pattern

public PostalCodeRandomField pattern(String newPattern)

Sets the pattern with keys that get replaced during nextValue(). Known keys are:

• KEY_DIGIT
• KEY_LETTER

Parameters:

newPattern - the pattern

Returns:

this instance

setPattern

public void setPattern(String pattern)

Sets the pattern with keys that get replaced during nextValue(). Known keys are:

• KEY_DIGIT
• KEY_LETTER

Parameters:

pattern - the pattern

getNullProbability

public double getNullProbability()

Returns the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Returns:

the probability between 0 and 1

nullProbability

public PostalCodeRandomField nullProbability(double newNullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

newNullProbability - the probability between 0 and 1

Returns:

this instance

setNullProbability

public void setNullProbability(double nullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

nullProbability - the probability between 0 and 1