org.forgerock.openam.utils

Class JsonValueBuilder

java.lang.Object

org.forgerock.openam.utils.JsonValueBuilder

public final class JsonValueBuilder
extends Object

Builder factory class for a fluent way of creating JsonValue objects.

Method Summary

Modifier and Type	Method and Description
static org.forgerock.json.JsonValue	fromResource(Class<?> relativeType, String resource) Construct a JsonValue from a classpath resource.
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Get singleton ObjectMapper instance for serialising to/from JSON.
static JsonObject	jsonValue() Creates a Builder object for creating JsonValue objects.
static org.forgerock.json.JsonValue	toJsonArray(InputStream json) Converts the passed input stream into a JsonValue represented as a list.
static org.forgerock.json.JsonValue	toJsonArray(String json) Converts the passed json string into a JsonValue represented as a list.
static org.forgerock.json.JsonValue	toJsonValue(byte[] json) Converts a byte array into a JsonValue.
static org.forgerock.json.JsonValue	toJsonValue(String json) Converts a String into a JsonValue.

Methods inherited from class java.lang.Object

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

Method Detail

jsonValue

public static JsonObject jsonValue()

Creates a Builder object for creating JsonValue objects.

Returns:

A Builder class for creating JsonValues.

toJsonValue

public static org.forgerock.json.JsonValue toJsonValue(String json)
                                                throws org.forgerock.json.JsonException

Converts a String into a JsonValue.

Parameters:

json - The json String.

Returns:

A JsonValue object.

Throws:

org.forgerock.json.JsonException - If there is a problem parsing the json String.

toJsonValue

public static org.forgerock.json.JsonValue toJsonValue(byte[] json)
                                                throws org.forgerock.json.JsonException

Converts a byte array into a JsonValue.

Parameters:

json - json represented in bytes

Returns:

A JsonValue object.

Throws:

org.forgerock.json.JsonException - If there is a problem parsing the json byte array.

toJsonArray

public static org.forgerock.json.JsonValue toJsonArray(String json)
                                                throws org.forgerock.json.JsonException

Converts the passed json string into a JsonValue represented as a list.

Parameters:

json - the json string

Returns:

a JsonValue instance represented as a list

Throws:

org.forgerock.json.JsonException - should an error occur whilst parsing the json

toJsonArray

public static org.forgerock.json.JsonValue toJsonArray(InputStream json)
                                                throws org.forgerock.json.JsonException

Converts the passed input stream into a JsonValue represented as a list.

Parameters:

json - an input stream

Returns:

a JsonValue instance represented as a list

Throws:

org.forgerock.json.JsonException - should an error occur whilst parsing the json

fromResource

public static org.forgerock.json.JsonValue fromResource(Class<?> relativeType,
                                                        String resource)

Construct a JsonValue from a classpath resource.

Parameters:

relativeType - The type to resolve the resource from.

resource - The resource path.

Returns:

The JsonValue.

getObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Get singleton ObjectMapper instance for serialising to/from JSON.

Returns:

the shared ObjectMapper instance.

See Also:

Jackson Best Practices: Performance