Package dev.siroshun.configapi.format.gson

Class GsonArrayFormat

java.lang.Object

dev.siroshun.configapi.format.gson.GsonArrayFormat

All Implemented Interfaces:

FileFormat<ListNode>

public final class GsonArrayFormat
extends Object

A FileFormat implementation that loading/saving ListNode from/to json files using Gson.

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
• CommentedNode - The comment will be dropped

Field Summary

Fields

Modifier and Type	Field	Description
static final GsonArrayFormat	DEFAULT	An instance of GsonArrayFormat that created from a plain GsonBuilder.
static final GsonArrayFormat	PRETTY_PRINTING	An instance of GsonArrayFormat that created from a GsonBuilder that set pretty printing.

Constructor Summary

Constructors

Constructor	Description
GsonArrayFormat(@NotNull com.google.gson.GsonBuilder gsonBuilder)	Creates a new GsonFormat from the GsonBuilder.

Method Summary

Modifier and Type	Method	Description
protected @NotNull ListNode	createEmptyNode()
ListNode	load(@NotNull Reader reader)	Loads a node from a Reader.
void	save(ListNode 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 GsonArrayFormat DEFAULT

An instance of GsonArrayFormat that created from a plain GsonBuilder.

PRETTY_PRINTING

public static final GsonArrayFormat PRETTY_PRINTING

An instance of GsonArrayFormat that created from a GsonBuilder that set pretty printing.

Constructor Details

GsonArrayFormat

public GsonArrayFormat(@NotNull
 @NotNull com.google.gson.GsonBuilder gsonBuilder)

Creates a new GsonFormat from the GsonBuilder.

Parameters:

gsonBuilder - the GsonBuilder

Method Details

createEmptyNode

@NotNull
protected @NotNull ListNode createEmptyNode()

load

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

Description copied from interface: FileFormat

Loads a node from a Reader.

Specified by:

load in interface FileFormat<N extends Node<?>>

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
 ListNode node,
 @NotNull
 @NotNull Writer writer)
          throws IOException

Description copied from interface: FileFormat

Saves a node to a Writer.

Specified by:

save in interface FileFormat<N extends Node<?>>

Parameters:

node - a root Node (FileFormat) to save

writer - a Writer to write a node

Throws:

IOException - if I/O error occurred