com.configcat

Class ConfigurationParser

java.lang.Object

com.configcat.ConfigurationParser

public class ConfigurationParser
extends java.lang.Object

A json parser which can be used to deserialize configuration json strings.

Constructor Summary

Constructors

Constructor and Description
ConfigurationParser()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getAllKeys(java.lang.String config) Gets all setting keys from the config json.
<T> T	parseValue(java.lang.Class<T> classOfT, java.lang.String config, java.lang.String key) Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).
<T> T	parseValue(java.lang.Class<T> classOfT, java.lang.String config, java.lang.String key, User user) Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationParser

public ConfigurationParser()

Method Detail

parseValue

public <T> T parseValue(java.lang.Class<T> classOfT,
                        java.lang.String config,
                        java.lang.String key)
                 throws com.configcat.ParsingFailedException,
                        java.lang.IllegalArgumentException

Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).

Type Parameters:

T - the type of the desired object.

Parameters:

classOfT - the class of T.

config - the json config.

key - the key of the value.

Returns:

the parsed value.

Throws:

ParsingFailedException - when the parsing failed.

java.lang.IllegalArgumentException - when the key or the config is empty or null, or when the <T> type is not supported.

parseValue

public <T> T parseValue(java.lang.Class<T> classOfT,
                        java.lang.String config,
                        java.lang.String key,
                        User user)
                 throws com.configcat.ParsingFailedException,
                        java.lang.IllegalArgumentException

Parses a json element identified by the key from the given json string into a primitive type (Boolean, Double, Integer or String).

Type Parameters:

T - the type of the desired object.

Parameters:

classOfT - the class of T.

config - the json config.

key - the key of the value.

user - the user object to identify the caller.

Returns:

the parsed value.

Throws:

ParsingFailedException - when the parsing failed.

java.lang.IllegalArgumentException - when the key or the config is empty or null, or when the <T> type is not supported.

getAllKeys

public java.util.Collection<java.lang.String> getAllKeys(java.lang.String config)
                                                  throws com.configcat.ParsingFailedException

Gets all setting keys from the config json.

Parameters:

config - the json config.

Returns:

a collection of the setting keys.

Throws:

ParsingFailedException - when the parsing failed.