net.morimekta.providence.testing.generator

Class MessageGenerator<Context extends GeneratorContext<Context>,Message extends PMessage<Message,Field>,Field extends PField>

java.lang.Object

net.morimekta.providence.testing.generator.MessageGenerator<Context,Message,Field>

All Implemented Interfaces:

Generator<Context,Message>

public class MessageGenerator<Context extends GeneratorContext<Context>,Message extends PMessage<Message,Field>,Field extends PField>
extends Object
implements Generator<Context,Message>

Message generator for generating a specific message.

Constructor Summary

Constructors

Constructor and Description
MessageGenerator(PMessageDescriptor<Message,Field> descriptor)

Method Summary

Modifier and Type	Method and Description
protected MessageGenerator<Context,Message,Field>	deepCopy()
Message	generate(Context options)
MessageGenerator<Context,Message,Field>	resetDefaultPresence() Reset all field presence probabilities to default based on the fill rate of the message generator options.
MessageGenerator<Context,Message,Field>	setAlwaysAbsent(Collection<Field> fields) Set which fields must never be generated.
MessageGenerator<Context,Message,Field>	setAlwaysAbsent(Field... fields) Set which fields must never be generated.
MessageGenerator<Context,Message,Field>	setAlwaysPresent(Collection<Field> fields) Set which fields must always be generated.
MessageGenerator<Context,Message,Field>	setAlwaysPresent(Field... fields) Set which fields must always be generated.
MessageGenerator<Context,Message,Field>	setDefaultPresence(Collection<Field> fields) Set default presence probability based on the default fill rate in the generator options instance.
MessageGenerator<Context,Message,Field>	setDefaultPresence(Field... fields) Set default presence probability based on the default fill rate in the generator options instance.
MessageGenerator<Context,Message,Field>	setValueGenerator(Field field, Generator<Context,?> generator)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageGenerator

public MessageGenerator(PMessageDescriptor<Message,Field> descriptor)

Method Detail

setAlwaysPresent

@SafeVarargs
public final MessageGenerator<Context,Message,Field> setAlwaysPresent(Field... fields)

Set which fields must always be generated. Note that unions only allow for one single field to be always present.

Parameters:

fields - The fields that must be generated for each instance.

Returns:

The message generator.

setAlwaysPresent

public MessageGenerator<Context,Message,Field> setAlwaysPresent(@Nonnull
                                                                Collection<Field> fields)

Set which fields must always be generated. Note that unions only allow for one single field to be always present.

Parameters:

fields - The fields that must be generated for each instance.

Returns:

The message generator.

setAlwaysAbsent

@SafeVarargs
public final MessageGenerator<Context,Message,Field> setAlwaysAbsent(Field... fields)

Set which fields must never be generated. If the message is a union then these fields will not be selected when getting a random field to get value for.

Parameters:

fields - The fields that should always be absent.

Returns:

The message generator.

setAlwaysAbsent

public MessageGenerator<Context,Message,Field> setAlwaysAbsent(@Nonnull
                                                               Collection<Field> fields)

Set which fields must never be generated. If the message is a union then these fields will not be selected when getting a random field to get value for.

Parameters:

fields - The fields that should always be absent.

Returns:

The message generator.

setDefaultPresence

@SafeVarargs
public final MessageGenerator<Context,Message,Field> setDefaultPresence(Field... fields)

Set default presence probability based on the default fill rate in the generator options instance.

Parameters:

fields - The fields the should have default presence probability.

Returns:

The message generator.

setDefaultPresence

public MessageGenerator<Context,Message,Field> setDefaultPresence(@Nonnull
                                                                  Collection<Field> fields)

Set default presence probability based on the default fill rate in the generator options instance.

Parameters:

fields - The fields the should have default presence probability.

Returns:

The message generator.

resetDefaultPresence

public MessageGenerator<Context,Message,Field> resetDefaultPresence()

Reset all field presence probabilities to default based on the fill rate of the message generator options.

Returns:

The message generator.

setValueGenerator

public MessageGenerator<Context,Message,Field> setValueGenerator(Field field,
                                                                 Generator<Context,?> generator)

generate

public Message generate(Context options)

Specified by:

generate in interface Generator<Context extends GeneratorContext<Context>,Message extends PMessage<Message,Field>>

Parameters:

options - The context to use when generating.

Returns:

The generated value.

deepCopy

protected MessageGenerator<Context,Message,Field> deepCopy()