com.electronwill.nightconfig.json

Class JsonParser

java.lang.Object

com.electronwill.nightconfig.json.JsonParser

All Implemented Interfaces:

com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>

public final class JsonParser
extends java.lang.Object
implements com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>

A JSON parser.

Constructor Summary

Constructors

Constructor and Description
JsonParser()

Method Summary

Modifier and Type	Method and Description
com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.Config>	getFormat()
boolean	isEmptyDataAccepted()
boolean	isTrailingDataAccepted()
com.electronwill.nightconfig.core.Config	parse(java.io.Reader reader) Parses a JSON object to a Config.
void	parse(java.io.Reader reader, com.electronwill.nightconfig.core.Config destination, com.electronwill.nightconfig.core.io.ParsingMode parsingMode) Parses a JSON object to a Config.
java.lang.Object	parseDocument(java.io.Reader reader) Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).
java.lang.Object	parseDocument(java.io.Reader reader, com.electronwill.nightconfig.core.Config configModel) Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).
java.lang.Object	parseDocument(java.lang.String json) Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).
<T> java.util.List<T>	parseList(java.io.Reader reader) Parses a JSON array to a List.
void	parseList(java.io.Reader reader, java.util.List<?> destination, com.electronwill.nightconfig.core.io.ParsingMode parsingMode) Parses a JSON array to a List.
void	parseList(java.io.Reader reader, java.util.List<?> destination, com.electronwill.nightconfig.core.io.ParsingMode parsingMode, com.electronwill.nightconfig.core.Config configModel) Parses a JSON array to a List, with a model for the configurations (JSON objects) contained in the list.
<T> java.util.List<T>	parseList(java.lang.String json) Parses a JSON array to a List.
JsonParser	setEmptyDataAccepted(boolean emptyDataAccepted) Enables or disables the acceptance of empty input data.
JsonParser	setTrailingDataAccepted(boolean trailingDataAccepted) Enables or disables the acceptance of trailing input data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.electronwill.nightconfig.core.io.ConfigParser

parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse

Constructor Detail

JsonParser

public JsonParser()

Method Detail

getFormat

public com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.Config> getFormat()

Specified by:

getFormat in interface com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>

isEmptyDataAccepted

public boolean isEmptyDataAccepted()

Returns:

true if the parser accepts empty data as a valid input, false otherwise (default)

setEmptyDataAccepted

public JsonParser setEmptyDataAccepted(boolean emptyDataAccepted)

Enables or disables the acceptance of empty input data. False by default. If set to true, the parser will return an empty config (or an empty list in the case of a parseList(Reader) call) when the input is empty.

Parameters:

emptyDataAccepted - true to accept empty data as a valid input, false to reject it

isTrailingDataAccepted

public boolean isTrailingDataAccepted()

Returns:

true if the parser accepts trailing data (data after the end of the JSON document) as a valid input, false otherwise (default)

setTrailingDataAccepted

public JsonParser setTrailingDataAccepted(boolean trailingDataAccepted)

Enables or disables the acceptance of trailing input data. False by default. If set to true, the parser will ignore any data that is after the end of the document.

Parameters:

trailingDataAccepted - true to accept trailing data (data after the end of the JSON document) as a valid input, false to reject it

parseDocument

public java.lang.Object parseDocument(java.lang.String json)

Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).

Parameters:

json - the data to parse

Returns:

either a JsonConfig or a List, depending on the document's type

parseDocument

public java.lang.Object parseDocument(java.io.Reader reader)

Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).

Parameters:

reader - the Reader to parse

Returns:

either a JsonConfig or a List, depending on the document's type

parseDocument

public java.lang.Object parseDocument(java.io.Reader reader,
                                      com.electronwill.nightconfig.core.Config configModel)

Parses a JSON document, either a JSON object (parsed to a JsonConfig) or a JSON array (parsed to a List).

Parameters:

reader - the Reader to parse

Returns:

either a JsonConfig or a List, depending on the document's type

parse

public com.electronwill.nightconfig.core.Config parse(java.io.Reader reader)

Parses a JSON object to a Config.

Specified by:

parse in interface com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>

parse

public void parse(java.io.Reader reader,
                  com.electronwill.nightconfig.core.Config destination,
                  com.electronwill.nightconfig.core.io.ParsingMode parsingMode)

Parses a JSON object to a Config.

Specified by:

parse in interface com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>

parseList

public <T> java.util.List<T> parseList(java.lang.String json)

Parses a JSON array to a List.

Parameters:

json - the data to parse

Returns:

a List with the content of the parsed array

parseList

public <T> java.util.List<T> parseList(java.io.Reader reader)

Parses a JSON array to a List.

Parameters:

reader - the Reader to parse

Returns:

a List with the content of the parsed array

parseList

public void parseList(java.io.Reader reader,
                      java.util.List<?> destination,
                      com.electronwill.nightconfig.core.io.ParsingMode parsingMode)

Parses a JSON array to a List.

Parameters:

reader - the Reader to parse

destination - the List where to put the data

parseList

public void parseList(java.io.Reader reader,
                      java.util.List<?> destination,
                      com.electronwill.nightconfig.core.io.ParsingMode parsingMode,
                      com.electronwill.nightconfig.core.Config configModel)

Parses a JSON array to a List, with a model for the configurations (JSON objects) contained in the list.

Parameters:

reader - the Reader to parse

destination - the List where to put the data