JSONObjectUtils (OAuth 2.0 SDK with OpenID Connect extensions 2.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.nimbusds.oauth2.sdk.util
Class JSONObjectUtils

java.lang.Object
  com.nimbusds.oauth2.sdk.util.JSONObjectUtils

public class JSONObjectUtils
extends Object
extends Object

JSON object helper methods for parsing and typed retrieval of member values.

Version:: $version$ (2013-01-28)
Author:: Vladimir Dzhuvinov

Method Summary

static boolean containsKey(net.minidev.json.JSONObject jsonObject, String key)
Returns true if the JSON object is defined and contains the specified key.

static boolean getBoolean(net.minidev.json.JSONObject o, String key)
Gets a boolean member of a JSON object.

static double getDouble(net.minidev.json.JSONObject o, String key)
Gets a number member of a JSON object as double.

static javax.mail.internet.InternetAddress getEmail(net.minidev.json.JSONObject o, String key)
Gets a string member of a JSON object as javax.mail.internet.InternetAddress.

static



<T extends Enum<T>> 


T

getEnum(net.minidev.json.JSONObject o,
               String key,
               Class<T> enumClass)

Gets a string member of a JSON object as an enumerated object.

static float getFloat(net.minidev.json.JSONObject o, String key)
Gets a number member of a JSON object float.

static int getInt(net.minidev.json.JSONObject o, String key)
Gets an number member of a JSON object as int.

static net.minidev.json.JSONArray getJSONArray(net.minidev.json.JSONObject o, String key)
Gets a JSON array member of a JSON object.

static net.minidev.json.JSONObject getJSONObject(net.minidev.json.JSONObject o, String key)
Gets a JSON object member of a JSON object.

static List<Object> getList(net.minidev.json.JSONObject o, String key)
Gets a list member of a JSON object.

static long getLong(net.minidev.json.JSONObject o, String key)
Gets a number member of a JSON object as long.

static String getString(net.minidev.json.JSONObject o, String key)
Gets a string member of a JSON object.

static String[] getStringArray(net.minidev.json.JSONObject o, String key)
Gets a string array member of a JSON object.

static URL getURL(net.minidev.json.JSONObject o, String key)
Gets a string member of a JSON object as java.net.URL.

static net.minidev.json.JSONObject parseJSONObject(String s)
Parses a JSON object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

containsKey

public static boolean containsKey(net.minidev.json.JSONObject jsonObject,
                                  String key)

Returns true if the JSON object is defined and contains the specified key.

Parameters:: jsonObject - The JSON object to check. May be null.; key - The key to check. Must not be null.
Returns:: true if the JSON object is defined and contains the specified key, else false.

parseJSONObject

public static net.minidev.json.JSONObject parseJSONObject(String s)
                                                   throws ParseException

Parses a JSON object.

Specific JSON to Java entity mapping (as per JSON Simple):

JSON numbers mapped to java.lang.Number.
JSON integer numbers mapped to long.
JSON fraction numbers mapped to double.

Parameters:: s - The JSON object string to parse. Must not be null.
Returns:: The JSON object.
Throws:: ParseException - If the string cannot be parsed to a JSON object.

getBoolean

public static boolean getBoolean(net.minidev.json.JSONObject o,
                                 String key)
                          throws ParseException

Gets a boolean member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getInt

public static int getInt(net.minidev.json.JSONObject o,
                         String key)
                  throws ParseException

Gets an number member of a JSON object as int.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getLong

public static long getLong(net.minidev.json.JSONObject o,
                           String key)
                    throws ParseException

Gets a number member of a JSON object as long.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getFloat

public static float getFloat(net.minidev.json.JSONObject o,
                             String key)
                      throws ParseException

Gets a number member of a JSON object float.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getDouble

public static double getDouble(net.minidev.json.JSONObject o,
                               String key)
                        throws ParseException

Gets a number member of a JSON object as double.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getString

public static String getString(net.minidev.json.JSONObject o,
                               String key)
                        throws ParseException

Gets a string member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getEnum

public static <T extends Enum<T>> T getEnum(net.minidev.json.JSONObject o,
                                            String key,
                                            Class<T> enumClass)
                                 throws ParseException

Gets a string member of a JSON object as an enumerated object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.; enumClass - The enumeration class. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getURL

public static URL getURL(net.minidev.json.JSONObject o,
                         String key)
                  throws ParseException

Gets a string member of a JSON object as java.net.URL.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getEmail

public static javax.mail.internet.InternetAddress getEmail(net.minidev.json.JSONObject o,
                                                           String key)
                                                    throws ParseException

Gets a string member of a JSON object as javax.mail.internet.InternetAddress.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getJSONArray

public static net.minidev.json.JSONArray getJSONArray(net.minidev.json.JSONObject o,
                                                      String key)
                                               throws ParseException

Gets a JSON array member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getList

public static List<Object> getList(net.minidev.json.JSONObject o,
                                   String key)
                            throws ParseException

Gets a list member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getStringArray

public static String[] getStringArray(net.minidev.json.JSONObject o,
                                      String key)
                               throws ParseException

Gets a string array member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.

getJSONObject

public static net.minidev.json.JSONObject getJSONObject(net.minidev.json.JSONObject o,
                                                        String key)
                                                 throws ParseException

Gets a JSON object member of a JSON object.

Parameters:: o - The JSON object. Must not be null.; key - The JSON object member key. Must not be null.
Returns:: The member value.
Throws:: ParseException - If the value is missing, null or not of the expected type.