de.slothsoft.random.types

Class PatternRandomField

java.lang.Object

de.slothsoft.random.types.PatternRandomField

All Implemented Interfaces:

RandomField

public class PatternRandomField
extends Object
implements RandomField

A field where you define a pattern and have a couple of random field to fill the pattern with.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
PatternRandomField(String pattern) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addComponent(String key, RandomField randomField) Adds a component that can be accessed by nextValue().
void	addComponents(Map<String,RandomField> addedComponents) Adds components that can be accessed by nextValue().
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.
PatternRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
PatternRandomField	pattern(String newPattern) Sets the pattern with keys that get replaced during nextValue().
void	removeComponent(String key) Removes a component that can be accessed by nextValue().
void	removeComponents(Set<String> keys) Removes components that can be accessed by 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

Constructor Detail

PatternRandomField

public PatternRandomField(String pattern)

Default constructor.

Parameters:

pattern - the pattern to fill

See Also:

addComponent(String, RandomField)

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

addComponent

public void addComponent(String key,
                         RandomField randomField)

Adds a component that can be accessed by nextValue().

Parameters:

key - the key that is replaced "as is"

randomField - the random field to replace this key with

addComponents

public void addComponents(Map<String,RandomField> addedComponents)

Adds components that can be accessed by nextValue().

Parameters:

addedComponents - with keys and random fields

See Also:

addComponent(String, RandomField)

removeComponent

public void removeComponent(String key)

Removes a component that can be accessed by nextValue().

Parameters:

key - the key that is replaced "as is"

removeComponents

public void removeComponents(Set<String> keys)

Removes components that can be accessed by nextValue().

Parameters:

keys - the keys

See Also:

removeComponent(String)

getPattern

public String getPattern()

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

Returns:

the pattern

pattern

public PatternRandomField pattern(String newPattern)

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

Parameters:

newPattern - the pattern

Returns:

this instance

setPattern

public void setPattern(String pattern)

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

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 PatternRandomField 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