Package com.github.siroshun09.configapi.format.yaml

Class YamlFormat

java.lang.Object

com.github.siroshun09.configapi.format.yaml.YamlFormat

All Implemented Interfaces:

FileFormat<MapNode>

public final class YamlFormat
extends Object
implements FileFormat<MapNode>

A FileFormat implementation that loading/saving MapNode from/to yaml files.

Supported Nodes:

• ValueNodes
  • CharValue and CharArray is written as String
  • EnumValue will be written as String using Enum.name()
  • Loading CharValue, CharArray, and EnumValue is not supported
• MapNode and ListNode
• ArrayNodes: serialize only
• NullNode
• ObjectNode that holds a basic Java object
  • The list of supported Java objects is in SafeRepresenter (snakeyaml)
  • Other object types are not supported

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	YamlFormat.Builder	A builder of YamlFormat.

Field Summary

Fields

Modifier and Type	Field	Description
static final YamlFormat	COMMENT_PROCESSING	An instance of YamlFormat that processes the comments.
static final YamlFormat	DEFAULT	An instance of default YamlFormat.

Method Summary

Modifier and Type	Method	Description
static @NotNull YamlFormat.Builder	builder()	Creates a new YamlFormat.Builder.
@NotNull MapNode	load(@NotNull Reader reader)	Loads a node from a Reader.
void	save(@NotNull MapNode node, @NotNull Writer writer)	Saves a node to a Writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.siroshun09.configapi.core.file.FileFormat

load, load, save, save

Field Details

DEFAULT

public static final YamlFormat DEFAULT

An instance of default YamlFormat.

COMMENT_PROCESSING

public static final YamlFormat COMMENT_PROCESSING

An instance of YamlFormat that processes the comments.

Method Details

builder

@NotNull
public static @NotNull YamlFormat.Builder builder()

Creates a new YamlFormat.Builder.

Returns:

a new YamlFormat.Builder

load

@NotNull
public @NotNull MapNode load(@NotNull
 @NotNull Reader reader)
                      throws IOException

Description copied from interface: FileFormat

Loads a node from a Reader.

Specified by:

load in interface FileFormat<MapNode>

Parameters:

reader - a Reader to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

save

public void save(@NotNull
 @NotNull MapNode node,
 @NotNull
 @NotNull Writer writer)
          throws IOException

Description copied from interface: FileFormat

Saves a node to a Writer.

Specified by:

save in interface FileFormat<MapNode>

Parameters:

node - a root Node (FileFormat) to save

writer - a Writer to write a node

Throws:

IOException - if I/O error occurred