org.codice.ddf.configuration.migration

Class JsonUtils

java.lang.Object

org.codice.ddf.configuration.migration.JsonUtils

public class JsonUtils
extends Object

This class provides utility functions for dealing with Json objects returned by the org.boon.json library.

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	convertToMap(Object o) Converts a given Json object to a Json map.
static boolean	getBooleanFrom(Map<String,Object> map, String key, boolean required) Retrieves a Json boolean from the specified Json map given its key.
static List<Object>	getListFrom(Map<String,Object> map, String key) Retrieves a Json array from the specified Json map given its key.
static Long	getLongFrom(Map<String,Object> map, String key, boolean required) Retrieves a Json number as a long from the specified Json map given its key.
static Map<String,Object>	getMapFrom(Map<String,Object> map, String key) Retrieves a Json map from the specified Json map given its key.
static String	getStringFrom(Map<String,Object> map, String key, boolean required) Retrieves a Json string from the specified Json map given its key.

Methods inherited from class java.lang.Object

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

Method Detail

convertToMap

public static Map<String,Object> convertToMap(@Nullable
                                              Object o)

Converts a given Json object to a Json map.

Parameters:

o - the Json object to return as a map

Returns:

the corresponding map

Throws:

MigrationException - if the given object is not a map

getMapFrom

public static Map<String,Object> getMapFrom(@Nullable
                                            Map<String,Object> map,
                                            @Nullable
                                            String key)

Retrieves a Json map from the specified Json map given its key.

Parameters:

map - the map to retrieve an entry from

key - the key for the entry to retrieve

Returns:

the corresponding Json map or an empty one if none defined

Throws:

MigrationException - if the specified entry is not a Json map

getListFrom

public static List<Object> getListFrom(@Nullable
                                       Map<String,Object> map,
                                       @Nullable
                                       String key)

Retrieves a Json array from the specified Json map given its key.

Parameters:

map - the map to retrieve an entry from

key - the key for the entry to retrieve

Returns:

the corresponding Json array as a list or an empty one if none defined

Throws:

MigrationException - if the specified entry is not a Json array

getStringFrom

public static String getStringFrom(@Nullable
                                   Map<String,Object> map,
                                   @Nullable
                                   String key,
                                   boolean required)

Retrieves a Json string from the specified Json map given its key.

Parameters:

map - the map to retrieve an entry from

key - the key for the entry to retrieve

required - true if the entry must exist in the map otherwise an error is generated; false to return null if it doesn't exist

Returns:

the corresponding Json string or null if it doesn't exist and required is false

Throws:

MigrationException - if the specified entry is not a Json string or if it doesn't exist and required is true

getLongFrom

public static Long getLongFrom(@Nullable
                               Map<String,Object> map,
                               @Nullable
                               String key,
                               boolean required)

Retrieves a Json number as a long from the specified Json map given its key.

Parameters:

map - the map to retrieve an entry from

key - the key for the entry to retrieve

required - true if the entry must exist in the map otherwise an error is generated; false to return null if it doesn't exist

Returns:

the corresponding Json number as a long or null if it doesn't exist and required is false

Throws:

MigrationException - if the specified entry is not a Json number or if it doesn't exist and required is true

getBooleanFrom

public static boolean getBooleanFrom(@Nullable
                                     Map<String,Object> map,
                                     @Nullable
                                     String key,
                                     boolean required)

Retrieves a Json boolean from the specified Json map given its key.

Parameters:

map - the map to retrieve an entry from

key - the key for the entry to retrieve

required - true if the entry must exist in the map otherwise an error is generated; false to return null if it doesn't exist

Returns:

the corresponding Json boolean or false if it doesn't exist and required is false

Throws:

MigrationException - if the specified entry is not a Json boolean or if it doesn't exist and required is true