de.slothsoft.random.types

Class StreetRandomField

java.lang.Object

de.slothsoft.random.types.ElementFromListRandomField<String>

de.slothsoft.random.types.StreetRandomField

All Implemented Interfaces:

RandomField

public class StreetRandomField
extends ElementFromListRandomField<String>

A RandomField representing a String that should look like a street (i.e. "High Street 10").

Since:

1.0.0

Author:

Stef Schulz

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_HOUSE_NUMBER Key that can be used by the pattern to display the house number.
static String	KEY_STREET Key that can be used by the pattern to display the street name.
static String	PATTERN_HOUSE_NUMBER_FIRST Pattern used in English speaking countries, e.g.
static String	PATTERN_STREET_FIRST Pattern used in Europe, e.g.

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
StreetRandomField() Default constructor.
StreetRandomField(String[] fields) Deprecated. use StreetRandomField() or ElementFromListRandomField.ElementFromListRandomField(Object[]) directly

Method Summary

Modifier and Type	Method and Description
int	getHouseNumberEndValue() Returns the end value, i.e.
int	getHouseNumberStartValue() Returns the start value for house numbers, i.e.
String	getPattern() Returns the pattern with keys that get replaced during nextValue().
StreetRandomField	houseNumberEndValue(int newEndValue) Sets the end value for house numbers, i.e.
StreetRandomField	houseNumberStartValue(int newStartValue) Sets the start value for house numbers, i.e.
String	nextValue() Returns a random value.
StreetRandomField	pattern(String newPattern) Sets the pattern with keys that get replaced during nextValue().
void	setHouseNumberEndValue(int endValue) Sets the end value for house numbers, i.e.
void	setHouseNumberStartValue(int startValue) Sets the start value for house numbers, i.e.
void	setPattern(String pattern) Sets the pattern with keys that get replaced during nextValue().

Methods inherited from class de.slothsoft.random.types.ElementFromListRandomField

getNullProbability, nullProbability, setNullProbability

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_STREET

public static final String KEY_STREET

Key that can be used by the pattern to display the street name.

See Also:

Constant Field Values

KEY_HOUSE_NUMBER

public static final String KEY_HOUSE_NUMBER

Key that can be used by the pattern to display the house number.

See Also:

Constant Field Values

PATTERN_STREET_FIRST

public static final String PATTERN_STREET_FIRST

Pattern used in Europe, e.g. "Hauptstraße 3".

See Also:

Constant Field Values

PATTERN_HOUSE_NUMBER_FIRST

public static final String PATTERN_HOUSE_NUMBER_FIRST

Pattern used in English speaking countries, e.g. "201 High Street".

See Also:

Constant Field Values

Constructor Detail

StreetRandomField

public StreetRandomField()

Default constructor.

Since:

2.1.0

StreetRandomField

@Deprecated
public StreetRandomField(String[] fields)

Deprecated. use StreetRandomField() or ElementFromListRandomField.ElementFromListRandomField(Object[]) directly

Old constructor.

Parameters:

fields - the street names

Method Detail

nextValue

public String nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Overrides:

nextValue in class ElementFromListRandomField<String>

Returns:

a random value

getPattern

public String getPattern()

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

• KEY_HOUSE_NUMBER
• KEY_STREET

Returns:

the pattern

Since:

2.1.0

pattern

public StreetRandomField pattern(String newPattern)

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

• KEY_HOUSE_NUMBER
• KEY_STREET

Parameters:

newPattern - the pattern

Returns:

this instance

Since:

2.1.0

setPattern

public void setPattern(String pattern)

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

• KEY_HOUSE_NUMBER
• KEY_STREET

Parameters:

pattern - the pattern

Since:

2.1.0

getHouseNumberStartValue

public int getHouseNumberStartValue()

Returns the start value for house numbers, i.e. the house number nextValue() will always be greater than this value.

Returns:

the start value

Since:

2.1.0

houseNumberStartValue

public StreetRandomField houseNumberStartValue(int newStartValue)

Sets the start value for house numbers, i.e. the house number nextValue() will always be greater than this value.

Parameters:

newStartValue - the start value

Returns:

this instance

Since:

2.1.0

setHouseNumberStartValue

public void setHouseNumberStartValue(int startValue)

Sets the start value for house numbers, i.e. the house number nextValue() will always be greater than this value.

Parameters:

startValue - the start value

Since:

2.1.0

getHouseNumberEndValue

public int getHouseNumberEndValue()

Returns the end value, i.e. nextValue() will always be less than this value.

Returns:

the end value

Since:

2.1.0

houseNumberEndValue

public StreetRandomField houseNumberEndValue(int newEndValue)

Sets the end value for house numbers, i.e. the house number of nextValue() will always be less than this value.

Parameters:

newEndValue - the end value

Returns:

this instance

Since:

2.1.0

setHouseNumberEndValue

public void setHouseNumberEndValue(int endValue)

Sets the end value for house numbers, i.e. the house number of nextValue() will always be less than this value.

Parameters:

endValue - the end value

Since:

2.1.0