org.fulib.yaml

Class YamlGenerator

java.lang.Object

org.fulib.yaml.YamlGenerator

public class YamlGenerator
extends java.lang.Object

This class provides static utility methods for generating Yaml strings.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
YamlGenerator()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encapsulate(java.lang.String value) Encapsulates a YAML value by enclosing it in quotes ("), if necessary.
static void	encapsulate(java.lang.String value, java.lang.Appendable writer) Encapsulates a YAML value by enclosing it in quotes ("), if necessary, and appends the result to the writer.
static java.lang.String	quote(java.lang.String value) Encapsulates a YAML value by enclosing it in quotes (").
static void	quote(java.lang.String value, java.lang.Appendable writer) Encapsulates a YAML value by enclosing it in quotes ("), and appends the result to the writer.
static java.lang.String	serialize(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.String>> events) Encodes the events as a list of YAML objects.
static void	serialize(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.String>> events, java.lang.Appendable writer) Encodes the events as a list of YAML objects into the writer.
static java.lang.String	serialize(java.util.Map<java.lang.String,java.lang.String> event) Encodes the event as a YAML object.
static void	serialize(java.util.Map<java.lang.String,java.lang.String> event, java.lang.Appendable writer) Encodes the event as a YAML object into the writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlGenerator

public YamlGenerator()

Method Detail

serialize

public static java.lang.String serialize(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.String>> events)

Encodes the events as a list of YAML objects.

Parameters:

events - the events

Returns:

the encoded YAML object list

serialize

public static void serialize(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.String>> events,
                             java.lang.Appendable writer)
                      throws java.io.IOException

Encodes the events as a list of YAML objects into the writer.

Parameters:

events - the events

writer - the writer

Throws:

java.io.IOException - when appending to the writer produces an error

serialize

public static java.lang.String serialize(java.util.Map<java.lang.String,java.lang.String> event)

Encodes the event as a YAML object.

Parameters:

event - the event

Returns:

the encoded YAML object

serialize

public static void serialize(java.util.Map<java.lang.String,java.lang.String> event,
                             java.lang.Appendable writer)
                      throws java.io.IOException

Encodes the event as a YAML object into the writer.

Parameters:

event - the event

writer - the writer

Throws:

java.io.IOException - when appending to the writer produces an error

encapsulate

public static java.lang.String encapsulate(java.lang.String value)

Encapsulates a YAML value by enclosing it in quotes ("), if necessary.

Parameters:

value - the YAML value to encapsulate

Returns:

the encapsulated YAML value

encapsulate

public static void encapsulate(java.lang.String value,
                               java.lang.Appendable writer)
                        throws java.io.IOException

Encapsulates a YAML value by enclosing it in quotes ("), if necessary, and appends the result to the writer.

Parameters:

value - the YAML value to encapsulate

writer - the writer

Throws:

java.io.IOException - when appending to the writer produces an error

quote

public static java.lang.String quote(java.lang.String value)

Encapsulates a YAML value by enclosing it in quotes (").

Parameters:

value - the YAML value to quote

Since:

1.3

quote

public static void quote(java.lang.String value,
                         java.lang.Appendable writer)
                  throws java.io.IOException

Encapsulates a YAML value by enclosing it in quotes ("), and appends the result to the writer.

Parameters:

value - the YAML value to quote

writer - the writer

Throws:

java.io.IOException - when appending to the writer produces an error

Since:

1.3