net.openhft.chronicle.wire.utils

Class MissingFieldAgitator

java.lang.Object

net.openhft.chronicle.wire.utils.MissingFieldAgitator

All Implemented Interfaces:

YamlAgitator

Deprecated.

@Deprecated
public class MissingFieldAgitator
extends Object
implements YamlAgitator

The MissingFieldAgitator class is an implementation of the YamlAgitator interface. It's designed to simulate missing fields in YAML content. Given a set of field names, this agitator will generate versions of the input YAML with these fields marked as missing. Fields that start with a '-' are implicitly ignored and aren't considered missing.

A primary use-case for this agitator would be in testing parsers or consumers of the YAML content to ensure they handle and react correctly to missing fields.

Constructor Summary

Constructors

Constructor and Description
MissingFieldAgitator(String... fields) Deprecated. Constructs a new MissingFieldAgitator with the specified field names to be marked as missing.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	generateInputs(String yaml) Deprecated. Generates a map of altered YAML inputs based on the provided YAML string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.utils.YamlAgitator

duplicateMessage, duplicateMessage, messageMissing, messageMissing, missingFields, overrideFields, replaceAll

Constructor Detail

MissingFieldAgitator

public MissingFieldAgitator(String... fields)

Deprecated.

Constructs a new MissingFieldAgitator with the specified field names to be marked as missing.

Parameters:

fields - Varargs of field names to be made missing.

Method Detail

generateInputs

public Map<String,String> generateInputs(String yaml)

Deprecated.

Description copied from interface: YamlAgitator

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.

Specified by:

generateInputs in interface YamlAgitator

Parameters:

yaml - The original YAML content to be agitated.

Returns:

A map of altered YAML inputs.