org.eth.cyril.util.configuration

Class JsonConfiguration

java.lang.Object

org.eth.cyril.util.configuration.JsonConfiguration

All Implemented Interfaces:

Configuration

public class JsonConfiguration
extends java.lang.Object
implements Configuration

Constructor Summary

Constructors

Constructor and Description
JsonConfiguration(javax.json.JsonObject object)

Method Summary

Modifier and Type	Method and Description
ConfigurationArray	getArray(java.lang.String name) Get an ConfigurationArray from this configuration if it exists.
boolean	getBoolean(java.lang.String name) Get a boolean property from this configuration if it exists.
Configuration	getInner(java.lang.String name) Get an inner Configuration object from this configuration if it exists.
java.lang.Number	getNumber(java.lang.String name) Get a number property from this configuration if it exists.
java.util.Collection<java.lang.String>	getProperties() Returns a collection of the property names available in this configuration.
java.lang.String	getString(java.lang.String name) Get a String property from this configuration if it exists.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eth.cyril.util.configuration.Configuration

get, getRawData, hasArray, hasBoolean, hasInner, hasNumber, hasString, tryGet, tryGetArray, tryGetBoolean, tryGetInner, tryGetNumber, tryGetString

Constructor Detail

JsonConfiguration

public JsonConfiguration(javax.json.JsonObject object)

Method Detail

getNumber

public java.lang.Number getNumber(java.lang.String name)
                           throws NoSuchPropertyException

Description copied from interface: Configuration

Get a number property from this configuration if it exists. For a safe way of getting the number, see Configuration.tryGetNumber(String).

Specified by:

getNumber in interface Configuration

Parameters:

name - The name of the property

Returns:

The number property stored under the given name

Throws:

NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws NoSuchPropertyException

Description copied from interface: Configuration

Get a boolean property from this configuration if it exists. For a safe way of getting the boolean, see Configuration.tryGetBoolean(String) .

Specified by:

getBoolean in interface Configuration

Parameters:

name - The name of the property

Returns:

The boolean property stored under the given name

Throws:

NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.

getString

public java.lang.String getString(java.lang.String name)
                           throws NoSuchPropertyException

Description copied from interface: Configuration

Get a String property from this configuration if it exists. For a safe way of getting the String, see Configuration.tryGetString(String) .

Specified by:

getString in interface Configuration

Parameters:

name - The name of the property

Returns:

The String property stored under the given name

Throws:

NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.

getArray

public ConfigurationArray getArray(java.lang.String name)
                            throws NoSuchPropertyException

Description copied from interface: Configuration

Get an ConfigurationArray from this configuration if it exists. For a safe way of getting the ConfigurationArray, see Configuration.tryGetArray(String). The returned array may be empty.

Specified by:

getArray in interface Configuration

Parameters:

name - The name of the property

Returns:

The ConfigurationArray property stored under the given name

Throws:

NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.

getInner

public Configuration getInner(java.lang.String name)
                       throws NoSuchPropertyException

Description copied from interface: Configuration

Get an inner Configuration object from this configuration if it exists. For a safe way of getting the inner Configuration, see Configuration.tryGetInner(String).

Specified by:

getInner in interface Configuration

Parameters:

name - The name of the property

Returns:

The Configuration property stored under the given name

Throws:

NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.

getProperties

public java.util.Collection<java.lang.String> getProperties()

Description copied from interface: Configuration

Returns a collection of the property names available in this configuration. Any element of this collection is guaranteed not to throw an exception when performing Configuration.get(String) and not to return an empty optional on Configuration.tryGet(String).

Specified by:

getProperties in interface Configuration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object