Package dev.siroshun.configapi.format.properties

Class PropertiesFormat

java.lang.Object

dev.siroshun.configapi.format.properties.PropertiesFormat

All Implemented Interfaces:

FileFormat<MapNode>

public final class PropertiesFormat
extends Object
implements FileFormat<MapNode>

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

When loading from properties file, all keys/values will store as String/StringValue.

Saving to properties file supports StringRepresentable nodes and CommentedNode with StringRepresentable node. Other Node types will throw IllegalArgumentException.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertiesFormat	DEFAULT	A default instance of PropertiesFormat.

Method Summary

Modifier and Type	Method	Description
@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 dev.siroshun.configapi.core.file.FileFormat

load, load, save, save

Field Details

DEFAULT

public static final PropertiesFormat DEFAULT

A default instance of PropertiesFormat.

Method Details

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