Module json.extensions.main

Package io.github.astrapi69.yaml

Class ObjectToYamlExtensions

java.lang.Object

io.github.astrapi69.yaml.ObjectToYamlExtensions

public final class ObjectToYamlExtensions
extends Object

The class ObjectToYamlExtensions converts java objects to yaml string objects

Method Summary

Modifier and Type	Method	Description
static <T> String	toYaml(List<T> list)	Creates from the given List a yaml string
static <T> String	toYaml(List<T> list, com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper)	Creates from the given List a yaml string
static <T> String	toYaml(T object)	Creates a yaml String from the given argument object
static <T> String	toYaml(T object, boolean newMapper)	Creates a yaml String from the given Object
static <T> String	toYaml(T object, com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper)	Creates a yaml String from the given Object and the given object mapper

Methods inherited from class java.lang.Object

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

Method Details

toYaml

public static <T> String toYaml(List<T> list)
                         throws IOException

Creates from the given List a yaml string

Type Parameters:

T - the generic type

Parameters:

list - the list

Returns:

the yaml string.

Throws:

IOException - Signals that an I/O exception has occurred.

toYaml

public static <T> String toYaml(List<T> list,
 com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper)
                         throws IOException

Creates from the given List a yaml string

Type Parameters:

T - the generic type

Parameters:

list - the list

mapper - the object mapper

Returns:

the yaml string

Throws:

IOException - Signals that an I/O exception has occurred

toYaml

public static <T> String toYaml(T object)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Creates a yaml String from the given argument object

Type Parameters:

T - the generic type of the given argument object

Parameters:

object - the object.

Returns:

the json string.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - If an error occurs when converting object to String

toYaml

public static <T> String toYaml(T object,
 boolean newMapper)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Creates a yaml String from the given Object

Type Parameters:

T - the generic type

Parameters:

object - the object

newMapper - flag that indicates if a new ObjectMapper should be created. if true a new ObjectMapper will be created otherwise the ObjectMapper from this class will be returned.

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - If an error occurs when converting object to String

toYaml

public static <T> String toYaml(T object,
 com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Creates a yaml String from the given Object and the given object mapper

Type Parameters:

T - the generic type

Parameters:

object - the object

mapper - the object mapper

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - If an error occurs when converting object to String