Package dev.orne.test.rnd.generators

Class SetGenerator

java.lang.Object

dev.orne.test.rnd.AbstractGenerator

dev.orne.test.rnd.params.AbstractParameterizableGenerator<P>

dev.orne.test.rnd.params.AbstractTypedParameterizableGenerator<Set<?>,CollectionGenerationParameters>

dev.orne.test.rnd.generators.SetGenerator

All Implemented Interfaces:

Generator, ParameterizableGenerator, TypedParameterizableGenerator<Set<?>>, TypedGenerator<Set<?>>

@API(status=STABLE,
     since="0.1")
@Priority(-2000)
public class SetGenerator
extends AbstractTypedParameterizableGenerator<Set<?>,CollectionGenerationParameters>

Generator of Set values. Requires supported component type generation in Generators.

Since:

0.1

Version:

1.0, 2022-12

Author:

(w) Iker Hernaez

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_SIZE	The maximum generated set size.
static final int	MIN_SIZE	The minimum generated set size.

Fields inherited from class dev.orne.test.rnd.AbstractGenerator

DEFAULT_NULL_PROBABILITY

Constructor Summary

Constructors

Constructor	Description
SetGenerator()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@NotNull Set<?>	defaultValue(@NotNull CollectionGenerationParameters parameters)	Returns the default value of the supported type for the specified parameters.
Set<?>	nullableRandomValue(@NotNull CollectionGenerationParameters parameters)	Returns a random value of the supported type for the specified parameters allowing null values.
<T> T	nullableRandomValue(@NotNull Class<T> type, @NotNull CollectionGenerationParameters parameters)	Returns a random value of the specified type and parameters.
protected Set<?>	randomNullablesSet(@NotNull CollectionGenerationParameters parameters)	Returns a random sized set of the specified component type allowing null component values.
protected @NotNull Set<?>	randomSet(@NotNull CollectionGenerationParameters parameters)	Returns a random sized set of the specified component type.
protected int	randomSize(@NotNull CollectionGenerationParameters parameters)	Returns a random set size.
@NotNull Set<?>	randomValue(@NotNull CollectionGenerationParameters parameters)	Returns a random value of the supported type for the specified parameters.
protected void	validateParameters(@NotNull CollectionGenerationParameters parameters)	Validates that the parameters contain enough information to generate the values.

Methods inherited from class dev.orne.test.rnd.params.AbstractTypedParameterizableGenerator

defaultValue, defaultValue, defaultValue, equals, getValueType, hashCode, nullableDefaultValue, nullableDefaultValue, nullableDefaultValue, nullableRandomValue, nullableRandomValue, randomValue, randomValue, randomValue, supports

Methods inherited from class dev.orne.test.rnd.params.AbstractParameterizableGenerator

createEmptyParams, createParams, defaultValue, defaultValue, getExtractor, getParametersType, nullableDefaultValue, nullableDefaultValue, nullableDefaultValue, nullableRandomValue, nullableRandomValue, randomValue, randomValue

Methods inherited from class dev.orne.test.rnd.AbstractGenerator

assertSupported, getNullProbability, randomNull, setNullProbability, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.orne.test.rnd.Generator

asParameterizable, defaultValue, getPriority, nullableDefaultValue, nullableRandomValue, randomValue

Methods inherited from interface dev.orne.test.rnd.params.ParameterizableGenerator

defaultValue, nullableDefaultValue, nullableRandomValue, randomValue

Field Details

MIN_SIZE

public static final int MIN_SIZE

The minimum generated set size.

See Also:

• Constant Field Values

MAX_SIZE

public static final int MAX_SIZE

The maximum generated set size.

See Also:

• Constant Field Values

Constructor Details

SetGenerator

public SetGenerator()

Creates a new instance.

Method Details

defaultValue

@NotNull
public @NotNull Set<?> defaultValue(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns the default value of the supported type for the specified parameters.

Specified by:

defaultValue in class AbstractTypedParameterizableGenerator<Set<?>,CollectionGenerationParameters>

Parameters:

parameters - The generation parameters

Returns:

The default value.

randomValue

@NotNull
public @NotNull Set<?> randomValue(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random value of the supported type for the specified parameters.

Specified by:

randomValue in class AbstractTypedParameterizableGenerator<Set<?>,CollectionGenerationParameters>

Parameters:

parameters - The generation parameters

Returns:

A random value.

nullableRandomValue

public <T> T nullableRandomValue(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random value of the specified type and parameters.

The returned value has a probability of be null except for native types when no NotNull constraint is present. If not null behaves as randomValue().

Overrides:

nullableRandomValue in class AbstractParameterizableGenerator<CollectionGenerationParameters>

Type Parameters:

T - The requested value type.

Parameters:

type - The requested value type.

parameters - The generation parameters

Returns:

A random nullable value for the specified type.

See Also:

• AbstractParameterizableGenerator.randomValue(Class, GenerationParameters)

nullableRandomValue

public Set<?> nullableRandomValue(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random value of the supported type for the specified parameters allowing null values.

The returned value has a probability of be null except for native types. If not null behaves as randomValue().

Overrides:

nullableRandomValue in class AbstractTypedParameterizableGenerator<Set<?>,CollectionGenerationParameters>

Parameters:

parameters - The generation parameters

Returns:

A random nullable value.

See Also:

• AbstractTypedParameterizableGenerator.randomValue()

validateParameters

protected void validateParameters(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Validates that the parameters contain enough information to generate the values.

Parameters:

parameters - The generation parameters.

randomSet

@NotNull
protected @NotNull Set<?> randomSet(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random sized set of the specified component type.

Parameters:

parameters - The generation parameters.

Returns:

A random set for the specified component type.

Throws:

GenerationException - If an error occurs generating the value

randomNullablesSet

protected Set<?> randomNullablesSet(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random sized set of the specified component type allowing null component values.

Parameters:

parameters - The generation parameters.

Returns:

A random set of the specified component type.

Throws:

GenerationException - If an error occurs generating the value

randomSize

protected int randomSize(@NotNull
 @NotNull CollectionGenerationParameters parameters)

Returns a random set size.

Parameters:

parameters - The generation parameters.

Returns:

The set size.