Package dev.siroshun.configapi.format.jackson

Class JacksonFormat

java.lang.Object

dev.siroshun.configapi.format.jackson.JacksonFormat

All Implemented Interfaces:

FileFormat<MapNode>

@NotNullByDefault
public final class JacksonFormat
extends Object
implements FileFormat<MapNode>

A FileFormat implementation that loading/saving MapNode from/to json files using Jackson's ObjectMapper.

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 JacksonFormat	DEFAULT	An instance of JacksonFormat that created from a plain ObjectMapper.
static final JacksonFormat	PRETTY_PRINTING	An instance of JacksonFormat that created from a ObjectMapper that is enabled pretty printing.

Constructor Summary

Constructors

Constructor	Description
JacksonFormat(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	The constructor of JacksonFormat.

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.core.util.DefaultPrettyPrinter	createDefaultPrettyPrinter()	Creates a DefaultPrettyPrinter that prints json like Gson.
MapNode	load(Reader reader)	Loads a node from a Reader.
MapNode	load(Path filepath)	Loads a node from a file.
void	save(MapNode node, 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, save, save

Field Details

DEFAULT

public static final JacksonFormat DEFAULT

An instance of JacksonFormat that created from a plain ObjectMapper.

PRETTY_PRINTING

public static final JacksonFormat PRETTY_PRINTING

An instance of JacksonFormat that created from a ObjectMapper that is enabled pretty printing.

Constructor Details

JacksonFormat

public JacksonFormat(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

The constructor of JacksonFormat.

Parameters:

objectMapper - an ObjectMapper that is used for serializing/deserializing json

Method Details

createDefaultPrettyPrinter

@Contract(" -> new")
public static com.fasterxml.jackson.core.util.DefaultPrettyPrinter createDefaultPrettyPrinter()

Creates a DefaultPrettyPrinter that prints json like Gson.

Returns:

a DefaultPrettyPrinter

load

public MapNode load(Path filepath)
             throws IOException

Description copied from interface: FileFormat

Loads a node from a file.

Specified by:

load in interface FileFormat<MapNode>

Parameters:

filepath - a filepath to load a node

Returns:

a loaded Node (FileFormat)

Throws:

IOException - if I/O error occurred

load

public MapNode load(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(MapNode node,
 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