dev.dejvokep.boostedyaml.utils.format

Interface Formatter<S,V>

Type Parameters:

S - the style type of the node

V - the value type

public interface Formatter<S,V>

An interface used to format (style) nodes.

Method Summary

Modifier and Type	Method and Description
S	format(org.snakeyaml.engine.v2.nodes.Tag tag, V value, NodeRole role, S def) Returns the format to use for the given node.
static <S,V> Formatter<S,V>	identity() Returns a formatter which returns the default style, as given to the method (as configured by the respective setting).

Method Detail

format

@NotNull
S format(@NotNull
                   org.snakeyaml.engine.v2.nodes.Tag tag,
                   @NotNull
                   V value,
                   @NotNull
                   NodeRole role,
                   @NotNull
                   S def)

Returns the format to use for the given node.

Please note that the returned style might be overridden in order to produce output compliant with the YAML specification. Please learn more at the corresponding setting documentation.

Parameters:

tag - the actual datatype the node is representing

value - value of the node (for scalars, this is a string-based representation)

role - role of the node

def - the default style (as configured by the respective setting)

Returns:

the style to use for the node

identity

@NotNull
static <S,V> Formatter<S,V> identity()

Returns a formatter which returns the default style, as given to the method (as configured by the respective setting).

Type Parameters:

S - the style type of the node

V - the value type

Returns:

the identity formatter