Class RandomValuePropertySource

java.lang.Object

org.springframework.core.env.PropertySource<Random>

org.springframework.boot.env.RandomValuePropertySource

public class RandomValuePropertySource
extends PropertySource<Random>

PropertySource that returns a random value for any property that starts with "random.". Where the "unqualified property name" is the portion of the requested property name beyond the "random." prefix, this PropertySource returns:

• When "int", a random Integer value, restricted by an optionally specified range.
• When "long", a random Long value, restricted by an optionally specified range.
• When "uuid", a random UUID value.
• Otherwise, a byte[].

The "random.int" and "random.long" properties supports a range suffix whose syntax is:

OPEN value (,max) CLOSE where the OPEN,CLOSE are any character and value,max are integers. If max is not provided, then 0 is used as the lower bound and value is the upper bound. If max is provided then value is the minimum value and max is the maximum (exclusive).

Since:

1.0.0

Author:

Dave Syer, Matt Benson, Madhura Bhave, Moritz Halbritter

Nested Class Summary

Nested classes/interfaces inherited from class PropertySource

PropertySource.StubPropertySource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RANDOM_PROPERTY_SOURCE_NAME	Name of the random PropertySource.

Fields inherited from class PropertySource

name, source

Constructor Summary

Constructors

Constructor	Description
RandomValuePropertySource()
RandomValuePropertySource(String name)

Method Summary

Modifier and Type	Method	Description
static void	addToEnvironment(ConfigurableEnvironment environment)	Add a RandomValuePropertySource to the given Environment.
static void	addToEnvironment(ConfigurableEnvironment environment, Log logger)	Add a RandomValuePropertySource to the given Environment.
@Nullable Object	getProperty(String name)

Methods inherited from class PropertySource

containsProperty, equals, getName, getSource, hashCode, named, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RANDOM_PROPERTY_SOURCE_NAME

public static final String RANDOM_PROPERTY_SOURCE_NAME

Name of the random PropertySource.

See Also:

• Constant Field Values

Constructor Details

RandomValuePropertySource

public RandomValuePropertySource()

RandomValuePropertySource

public RandomValuePropertySource(String name)

Method Details

getProperty

public @Nullable Object getProperty(String name)

Specified by:

getProperty in class PropertySource<Random>

addToEnvironment

public static void addToEnvironment(ConfigurableEnvironment environment)

Add a RandomValuePropertySource to the given Environment.

Parameters:

environment - the environment to add the random property source to

addToEnvironment

public static void addToEnvironment(ConfigurableEnvironment environment,
 Log logger)

Add a RandomValuePropertySource to the given Environment.

Parameters:

environment - the environment to add the random property source to

logger - logger used for debug and trace information

Since:

4.0.0