Package dev.siroshun.configapi.format.binary

Class BinaryFormat

java.lang.Object

dev.siroshun.configapi.format.binary.BinaryFormat

All Implemented Interfaces:

FileFormat<Node<?>>

public final class BinaryFormat
extends Object
implements FileFormat<Node<?>>

A FileFormat implementation that loading/saving MapNode from/to binary format.

Supported Nodes:

• ValueNodes excluding EnumValue
• ArrayNode, ListNode and MapNode
• NullNode
• CommentedNode - The comment will be dropped

For specifications of this format, please see the comments in the source code.

Field Summary

Fields

Modifier and Type	Field	Description
static final BinaryFormat	DEFAULT	An instance of BinaryFormat.

Method Summary

Modifier and Type	Method	Description
@NotNull Node<?>	load(@NotNull InputStream input)	Loads a node from a InputStream.
@NotNull Node<?>	load(@NotNull Reader reader)	Deprecated. Not supported
@NotNull Node<?>	load(@NotNull Path filepath)	Loads a node from a file.
void	save(@NotNull Node<?> node, @NotNull OutputStream output)	Saves a node to a OutputStream.
void	save(@NotNull Node<?> node, @NotNull Writer writer)	Deprecated. Not supported
void	save(@NotNull Node<?> node, @NotNull Path filepath)	Saves a node to a file.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final BinaryFormat DEFAULT

An instance of BinaryFormat.

Method Details

load

@NotNull
public @NotNull Node<?> load(@NotNull
 @NotNull Path filepath)
                      throws IOException

Description copied from interface: FileFormat

Loads a node from a file.

Specified by:

load in interface FileFormat<Node<?>>

Parameters:

filepath - a filepath to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

load

@NotNull
public @NotNull Node<?> load(@NotNull
 @NotNull InputStream input)
                      throws IOException

Description copied from interface: FileFormat

Loads a node from a InputStream.

Specified by:

load in interface FileFormat<Node<?>>

Parameters:

input - a InputStream to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

save

public void save(@NotNull
 @NotNull Node<?> node,
 @NotNull
 @NotNull Path filepath)
          throws IOException

Description copied from interface: FileFormat

Saves a node to a file.

Specified by:

save in interface FileFormat<Node<?>>

Parameters:

node - a root Node (FileFormat) to save

filepath - a filepath to write a node

Throws:

IOException - if I/O error occurred

save

public void save(@NotNull
 @NotNull Node<?> node,
 @NotNull
 @NotNull OutputStream output)
          throws IOException

Description copied from interface: FileFormat

Saves a node to a OutputStream.

Specified by:

save in interface FileFormat<Node<?>>

Parameters:

node - a root Node (FileFormat) to save

output - a OutputStream to write a node

Throws:

IOException - if I/O error occurred

load

@Deprecated
@NotNull
public @NotNull Node<?> load(@NotNull
 @NotNull Reader reader)

Deprecated.

Not supported

Loads a node from a Reader.

Specified by:

load in interface FileFormat<Node<?>>

Parameters:

reader - a Reader to load a node

Returns:

a loaded Node (FileFormat)

save

@Deprecated
public void save(@NotNull
 @NotNull Node<?> node,
 @NotNull
 @NotNull Writer writer)

Deprecated.

Not supported

Saves a node to a Writer.

Specified by:

save in interface FileFormat<Node<?>>

Parameters:

node - a root Node (FileFormat) to save

writer - a Writer to write a node