net.openhft.chronicle.wire.utils

Interface YamlAgitator

All Known Implementing Classes:

DuplicateMessageAgitator, MessageMissingAgitator, MissingFieldAgitator, OverrideFieldAgitator, RegexFieldAgitator

Deprecated.

@Deprecated
public interface YamlAgitator

The YamlAgitator interface defines methods for manipulating and altering YAML content. Implementations of this interface can apply specific changes to YAML input, such as missing fields, duplicating messages, or applying regex transformations.

Through its static methods, the interface offers access to various concrete agitator implementations, enabling different ways of agitating YAML content.

Method Summary

Modifier and Type	Method and Description
static YamlAgitator	duplicateMessage() Deprecated. Provides a YamlAgitator that duplicates messages.
static YamlAgitator	duplicateMessage(int limit) Deprecated. Provides a YamlAgitator that duplicates messages up to a given limit.
Map<String,String>	generateInputs(String yaml) Deprecated. Generates a map of altered YAML inputs based on the provided YAML string.
static YamlAgitator	messageMissing() Deprecated. Provides a YamlAgitator that handles missing messages.
static YamlAgitator	messageMissing(int limit) Deprecated. Provides a YamlAgitator that handles missing messages up to a given limit.
static YamlAgitator	missingFields(String... fields) Deprecated. Provides a YamlAgitator that flags specified fields as missing.
static YamlAgitator	overrideFields(String... fields) Deprecated. Provides a YamlAgitator that overrides the values of specified fields.
static YamlAgitator	replaceAll(String name, String regex, String replaceAll) Deprecated. Provides a YamlAgitator that applies regex transformations on fields.

Method Detail

messageMissing

static YamlAgitator messageMissing()

Deprecated.

Provides a YamlAgitator that handles missing messages.

Returns:

An instance of MessageMissingAgitator with default settings.

messageMissing

static YamlAgitator messageMissing(int limit)

Deprecated.

Provides a YamlAgitator that handles missing messages up to a given limit.

Parameters:

limit - The maximum number of missing messages to handle.

Returns:

An instance of MessageMissingAgitator set to the provided limit.

duplicateMessage

static YamlAgitator duplicateMessage()

Deprecated.

Provides a YamlAgitator that duplicates messages.

Returns:

An instance of DuplicateMessageAgitator with default settings.

duplicateMessage

static YamlAgitator duplicateMessage(int limit)

Deprecated.

Provides a YamlAgitator that duplicates messages up to a given limit.

Parameters:

limit - The maximum number of messages to duplicate.

Returns:

An instance of DuplicateMessageAgitator set to the provided limit.

missingFields

static YamlAgitator missingFields(String... fields)

Deprecated.

Provides a YamlAgitator that flags specified fields as missing.

Parameters:

fields - An array of field names to be flagged as missing.

Returns:

An instance of MissingFieldAgitator with the specified missing fields.

overrideFields

static YamlAgitator overrideFields(String... fields)

Deprecated.

Provides a YamlAgitator that overrides the values of specified fields.

Parameters:

fields - An array of field names to be overridden.

Returns:

An instance of OverrideFieldAgitator for the specified fields.

replaceAll

static YamlAgitator replaceAll(String name,
                               String regex,
                               String replaceAll)

Deprecated.

Provides a YamlAgitator that applies regex transformations on fields.

Parameters:

name - The name of the field to be transformed.

regex - The regex pattern to be applied.

replaceAll - The replacement string.

Returns:

An instance of RegexFieldAgitator with the specified transformation parameters.

generateInputs

Map<String,String> generateInputs(String yaml)

Deprecated.

Generates a map of altered YAML inputs based on the provided YAML string. The key in the returned map represents the modified YAML content, while the value provides a descriptor or label for the specific alteration made.

Parameters:

yaml - The original YAML content to be agitated.

Returns:

A map of altered YAML inputs.