org.rundeck.toolbelt.format.yaml.snakeyaml

Class YamlFormatter

java.lang.Object

org.rundeck.toolbelt.BaseDataOutputFormatter

org.rundeck.toolbelt.format.yaml.snakeyaml.YamlFormatter

All Implemented Interfaces:

org.rundeck.toolbelt.OutputFormatter

public class YamlFormatter
extends org.rundeck.toolbelt.BaseDataOutputFormatter

Format objects as YAML, this will convert any Map/Collection into Yaml, and any Object that implements Formatable and returns a non-null Map or List. If the object does not correspond to one of those inputs, the base formatter will be used

Constructor Summary

Constructors

Constructor and Description
YamlFormatter()
YamlFormatter(java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter, org.yaml.snakeyaml.Yaml yaml)
YamlFormatter(org.rundeck.toolbelt.OutputFormatter base)
YamlFormatter(org.rundeck.toolbelt.OutputFormatter base, org.yaml.snakeyaml.DumperOptions options)
YamlFormatter(org.rundeck.toolbelt.OutputFormatter base, java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter, org.yaml.snakeyaml.Yaml yaml)
YamlFormatter(org.yaml.snakeyaml.representer.Representer representer, org.yaml.snakeyaml.DumperOptions options)

Method Summary

Modifier and Type	Method and Description
protected boolean	canFormatObject(java.lang.Object value)
protected java.lang.String	formatObject(java.lang.Object o)
protected org.rundeck.toolbelt.OutputFormatter	withBase(java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter, org.rundeck.toolbelt.OutputFormatter base)

Methods inherited from class org.rundeck.toolbelt.BaseDataOutputFormatter

format, formatList, formatMap, withBase

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFormatter

public YamlFormatter()

YamlFormatter

public YamlFormatter(org.yaml.snakeyaml.representer.Representer representer,
                     org.yaml.snakeyaml.DumperOptions options)

YamlFormatter

public YamlFormatter(java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter,
                     org.yaml.snakeyaml.Yaml yaml)

YamlFormatter

public YamlFormatter(org.rundeck.toolbelt.OutputFormatter base)

Parameters:

base - base formatter

YamlFormatter

public YamlFormatter(org.rundeck.toolbelt.OutputFormatter base,
                     java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter,
                     org.yaml.snakeyaml.Yaml yaml)

YamlFormatter

public YamlFormatter(org.rundeck.toolbelt.OutputFormatter base,
                     org.yaml.snakeyaml.DumperOptions options)

Parameters:

base - base formatter

options - yaml options

Method Detail

withBase

protected org.rundeck.toolbelt.OutputFormatter withBase(java.util.function.Function<java.lang.Object,java.util.Optional<org.rundeck.toolbelt.Formatable>> dataFormatter,
                                                        org.rundeck.toolbelt.OutputFormatter base)

Specified by:

withBase in class org.rundeck.toolbelt.BaseDataOutputFormatter

canFormatObject

protected boolean canFormatObject(java.lang.Object value)

Specified by:

canFormatObject in class org.rundeck.toolbelt.BaseDataOutputFormatter

formatObject

protected java.lang.String formatObject(java.lang.Object o)

Specified by:

formatObject in class org.rundeck.toolbelt.BaseDataOutputFormatter