net.obvj.confectory.helper

Class JSONObjectHelper

java.lang.Object

net.obvj.confectory.helper.AbstractBasicConfigurationHelper<org.json.JSONObject>

net.obvj.confectory.helper.JSONObjectHelper

All Implemented Interfaces:

ConfigurationDataRetriever<org.json.JSONObject>, ConfigurationHelper<org.json.JSONObject>

public class JSONObjectHelper
extends AbstractBasicConfigurationHelper<org.json.JSONObject>

A specialized Configuration Helper that retrieves data from JSON.org's JSONObject, with JSONPath capabilities.

Since:

0.2.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor and Description
JSONObjectHelper(org.json.JSONObject jsonObject) Creates a new helper for the given JSONObject.

Method Summary

Modifier and Type	Method and Description
Optional<org.json.JSONObject>	getBean()
boolean	getBoolean(String jsonPath) Returns the boolean value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to boolean.
double	getDouble(String jsonPath) Returns the double value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to double.
int	getInt(String jsonPath) Returns the int value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to int.
long	getLong(String jsonPath) Returns the long value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to long.
String	getString(String jsonPath) Returns the String value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element.

Methods inherited from class net.obvj.confectory.helper.AbstractBasicConfigurationHelper

setNullValueProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONObjectHelper

public JSONObjectHelper(org.json.JSONObject jsonObject)

Creates a new helper for the given JSONObject.

Parameters:

jsonObject - the JSON object to be set

Method Detail

getBean

public Optional<org.json.JSONObject> getBean()

Returns:

the JSON.org's JSONObject in context

getBoolean

public boolean getBoolean(String jsonPath)

Returns the boolean value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to boolean.

Parameters:

jsonPath - the path to read

Returns:

the boolean value associated with the specified jsonPath

Throws:

ConfigurationException - if the jsonPath expression returns more than a single element

ClassCastException - if the jsonPath result cannot be assigned to boolean

getInt

public int getInt(String jsonPath)

Returns the int value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to int.

Parameters:

jsonPath - the path to read

Returns:

the int value associated with the specified jsonPath

Throws:

ConfigurationException - if the jsonPath expression returns more than a single element

ClassCastException - if the jsonPath result cannot be assigned to int

getLong

public long getLong(String jsonPath)

Returns the long value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to long.

Parameters:

jsonPath - the path to read

Returns:

the long value associated with the specified jsonPath

Throws:

ConfigurationException - if the jsonPath expression returns more than a single element

ClassCastException - if the jsonPath result cannot be assigned to long

getDouble

public double getDouble(String jsonPath)

Returns the double value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element that can be mapped to double.

Parameters:

jsonPath - the path to read

Returns:

the double value associated with the specified jsonPath

Throws:

ConfigurationException - if the jsonPath expression returns more than a single element

ClassCastException - if the jsonPath result cannot be assigned to double

getString

public String getString(String jsonPath)

Returns the String value associated with the specified jsonPath in the JSONObject in context, provided that the expression returns a single element.

Parameters:

jsonPath - the path to read

Returns:

the String value associated with the specified jsonPath

Throws:

ConfigurationException - if the jsonPath expression returns more than a single element