Package dev.siroshun.configapi.core.file

Interface FileFormat<N extends Node<?>>

Type Parameters:

N - a type of root node

All Known Implementing Classes:

BinaryFormat, GsonArrayFormat, GsonFormat, JacksonFormat, PropertiesFormat, YamlFormat

@NotNullByDefault
public interface FileFormat<N extends Node<?>>

An interface for loading/saving Nodes from/to files.

Method Summary

Modifier and Type	Method	Description
default N	load(InputStream input)	Loads a node from a InputStream.
N	load(Reader reader)	Loads a node from a Reader.
default N	load(Path filepath)	Loads a node from a file.
default void	save(N node, OutputStream output)	Saves a node to a OutputStream.
void	save(N node, Writer writer)	Saves a node to a Writer.
default void	save(N node, Path filepath)	Saves a node to a file.

Method Details

load

N load(Reader reader)
throws IOException

Loads a node from a Reader.

Parameters:

reader - a Reader to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

load

default N load(Path filepath)
        throws IOException

Loads a node from a file.

Parameters:

filepath - a filepath to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

load

default N load(InputStream input)
        throws IOException

Loads a node from a InputStream.

Parameters:

input - a InputStream to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

save

void save(N node,
 Writer writer)
   throws IOException

Saves a node to a Writer.

Parameters:

node - a root Node (FileFormat) to save

writer - a Writer to write a node

Throws:

IOException - if I/O error occurred

save

default void save(N node,
 Path filepath)
           throws IOException

Saves a node to a file.

Parameters:

node - a root Node (FileFormat) to save

filepath - a filepath to write a node

Throws:

IOException - if I/O error occurred

save

default void save(N node,
 OutputStream output)
           throws IOException

Saves a node to a OutputStream.

Parameters:

node - a root Node (FileFormat) to save

output - a OutputStream to write a node

Throws:

IOException - if I/O error occurred