org.apache.shardingsphere.infra.util.yaml

Class YamlEngine

java.lang.Object

org.apache.shardingsphere.infra.util.yaml.YamlEngine

public final class YamlEngine
extends Object

YAML engine.

Constructor Summary

Constructors

Constructor and Description
YamlEngine()

Method Summary

Modifier and Type	Method and Description
static String	marshal(Object value) Marshal YAML.
static <T extends YamlConfiguration> T	unmarshal(byte[] yamlBytes, Class<T> classType) Unmarshal YAML.
static <T extends YamlConfiguration> T	unmarshal(File yamlFile, Class<T> classType) Unmarshal YAML.
static <T> T	unmarshal(String yamlContent, Class<T> classType) Unmarshal YAML.
static <T> T	unmarshal(String yamlContent, Class<T> classType, boolean skipMissingProps) Unmarshal YAML.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlEngine

public YamlEngine()

Method Detail

unmarshal

public static <T extends YamlConfiguration> T unmarshal(File yamlFile,
                                                        Class<T> classType)
                                                 throws IOException

Unmarshal YAML.

Type Parameters:

T - type of class

Parameters:

yamlFile - YAML file

classType - class type

Returns:

object from YAML

Throws:

IOException - IO Exception

unmarshal

public static <T extends YamlConfiguration> T unmarshal(byte[] yamlBytes,
                                                        Class<T> classType)
                                                 throws IOException

Unmarshal YAML.

Type Parameters:

T - type of class

Parameters:

yamlBytes - YAML bytes

classType - class type

Returns:

object from YAML

Throws:

IOException - IO Exception

unmarshal

public static <T> T unmarshal(String yamlContent,
                              Class<T> classType)

Unmarshal YAML.

Type Parameters:

T - type of class

Parameters:

yamlContent - YAML content

classType - class type

Returns:

object from YAML

unmarshal

public static <T> T unmarshal(String yamlContent,
                              Class<T> classType,
                              boolean skipMissingProps)

Unmarshal YAML.

Type Parameters:

T - type of class

Parameters:

yamlContent - YAML content

classType - class type

skipMissingProps - true if missing properties should be skipped, false otherwise

Returns:

object from YAML

marshal

public static String marshal(Object value)

Marshal YAML.

Parameters:

value - object to be marshaled

Returns:

YAML content