com.hazelcast.internal.yaml

Class YamlUtil

java.lang.Object

com.hazelcast.internal.yaml.YamlUtil

public final class YamlUtil
extends Object

Utility class for working with YAML nodes.

Method Summary

Modifier and Type	Method and Description
static YamlMapping	asMapping(YamlNode node) Takes a generic YamlNode instance and returns it casted to YamlMapping if the type of the node is a descendant of YamlMapping.
static YamlScalar	asScalar(YamlNode node) Takes a generic YamlNode instance and returns it casted to YamlScalar if the type of the node is a descendant of YamlScalar.
static YamlSequence	asSequence(YamlNode node) Takes a generic YamlNode instance and returns it casted to YamlSequence if the type of the node is a descendant of YamlSequence.
static <T> T	asType(YamlNode node, Class<T> type) Takes a generic YamlNode instance and returns it casted to the provided type if the node is an instance of that type.
static String	constructPath(YamlNode parent, String childName) Constructs the path of the node with the provided parent node and nodeName.
static void	ensureRunningOnJava8OrHigher() Checks if the runtime environment is Java8 or higher.
static boolean	isMapping(YamlNode node) Checks if the provided node is a mapping
static boolean	isOfSameType(YamlNode left, YamlNode right) Checks if the two provided nodes are of the same type
static boolean	isScalar(YamlNode node) Checks if the provided node is a scalar
static boolean	isSequence(YamlNode node) Checks if the provided node is a sequence

Methods inherited from class java.lang.Object

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

Method Detail

asMapping

public static YamlMapping asMapping(YamlNode node)

Takes a generic YamlNode instance and returns it casted to YamlMapping if the type of the node is a descendant of YamlMapping.

Parameters:

node - The generic node to cast

Returns:

the casted mapping

Throws:

YamlException - if the provided node is not a mapping

asSequence

public static YamlSequence asSequence(YamlNode node)

Takes a generic YamlNode instance and returns it casted to YamlSequence if the type of the node is a descendant of YamlSequence.

Parameters:

node - The generic node to cast

Returns:

the casted sequence

Throws:

YamlException - if the provided node is not a sequence

asScalar

public static YamlScalar asScalar(YamlNode node)

Takes a generic YamlNode instance and returns it casted to YamlScalar if the type of the node is a descendant of YamlScalar.

Parameters:

node - The generic node to cast

Returns:

the casted scalar

Throws:

YamlException - if the provided node is not a scalar

asType

public static <T> T asType(YamlNode node,
                           Class<T> type)

Takes a generic YamlNode instance and returns it casted to the provided type if the node is an instance of that type.

Parameters:

node - The generic node to cast

Returns:

the casted node

Throws:

YamlException - if the provided node is not the expected type

ensureRunningOnJava8OrHigher

public static void ensureRunningOnJava8OrHigher()

Checks if the runtime environment is Java8 or higher. If the runtime is an older version the check throws UnsupportedOperationException.

Throws:

UnsupportedOperationException - If the runtime environment is not Java8 or higher

constructPath

public static String constructPath(YamlNode parent,
                                   String childName)

Constructs the path of the node with the provided parent node and nodeName.

Parameters:

parent - The parent node

childName - The name of the node the path is constructed for

Returns:

the constructed path of the node

isMapping

public static boolean isMapping(YamlNode node)

Checks if the provided node is a mapping

Parameters:

node - The node to check

Returns:

true if the provided node is a mapping

isSequence

public static boolean isSequence(YamlNode node)

Checks if the provided node is a sequence

Parameters:

node - The node to check

Returns:

true if the provided node is a sequence

isScalar

public static boolean isScalar(YamlNode node)

Checks if the provided node is a scalar

Parameters:

node - The node to check

Returns:

true if the provided node is a scalar

isOfSameType

public static boolean isOfSameType(YamlNode left,
                                   YamlNode right)

Checks if the two provided nodes are of the same type

Parameters:

left - The left-side node of the check

right - The right-side node of the check

Returns:

true if the provided nodes are of the same type