public final class DocumentTranscoder extends Object
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentTranscoder.Decoder
A functional interface describing a method that decodes a JSON String
into a map of key-value pairs.
|
static interface |
DocumentTranscoder.Encoder
A functional interface describing a method that encodes a map of
key-value pairs into a JSON String.
|
Modifier and Type | Field and Description |
---|---|
static String |
ROOT
The element name of the root node in the JSON configuration file.
|
Modifier and Type | Method and Description |
---|---|
static Project |
load(Path location,
DocumentTranscoder.Decoder decoder)
Loads a project from a UTF-8 encoded file.
|
static Project |
load(String json,
DocumentTranscoder.Decoder decoder)
Loads a new
Project from the specified JSON string. |
static String |
save(Project project,
DocumentTranscoder.Encoder encoder)
Returns a JSON representation of the specified project node.
|
static void |
save(Project project,
Path location,
DocumentTranscoder.Encoder encoder)
Saves the project in a UTF-8 encoded file.
|
public static final String ROOT
public static String save(Project project, DocumentTranscoder.Encoder encoder) throws SpeedmentConfigException
project
- the projectencoder
- the encoder to useSpeedmentConfigException
- if the inputed object is not validpublic static void save(Project project, Path location, DocumentTranscoder.Encoder encoder) throws SpeedmentConfigException
project
- to saveencoder
- the encoder to uselocation
- for the UTF-8 encoded fileSpeedmentConfigException
- if the file could not be savedpublic static Project load(String json, DocumentTranscoder.Decoder decoder) throws SpeedmentConfigException
Project
from the specified JSON string.json
- the input jsondecoder
- the decoder to useSpeedmentConfigException
- if the file couldn't be loadedpublic static Project load(Path location, DocumentTranscoder.Decoder decoder) throws SpeedmentConfigException
location
- for the UTF-8 encoded filedecoder
- the decoder to useSpeedmentConfigException
- if the file could not be loadedCopyright © 2017 Speedment, Inc.. All rights reserved.