org.forgerock.json.ref

Class JsonReference

java.lang.Object

org.forgerock.json.ref.JsonReference

public class JsonReference
extends Object

Represents a JSON Reference value.

Constructor Summary

Constructors

Constructor and Description
JsonReference() Constructs an empty JSON Reference object.

Method Summary

Modifier and Type	Method and Description
JsonReference	fromJsonValue(JsonValue value) Initializes this object from a $ref JSON object value.
URI	getURI() Returns the URI of the value being referenced.
static boolean	isJsonReference(JsonValue value) Returns true if the specified JSON value contains a valid $ref JSON object structure.
JsonReference	setURI(URI uri) Sets the URI of the value being referenced.
JsonValue	toJsonValue() Returns this object as a $ref JSON object value.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonReference

public JsonReference()

Constructs an empty JSON Reference object.

Method Detail

isJsonReference

public static boolean isJsonReference(JsonValue value)

Returns true if the specified JSON value contains a valid $ref JSON object structure. Note: This method does not suppress transformers in the specified value. Consequently, this method can return false if members are transformed, for example if a JsonReferenceTransformer transforms the value as it is being inspected.

Parameters:

value - the value to test for a JSON Reference.

Returns:

true if the value is a $ref JSON Reference.

getURI

public URI getURI()

Returns the URI of the value being referenced.

Returns:

The URI.

setURI

public JsonReference setURI(URI uri)

Sets the URI of the value being referenced.

Parameters:

uri - the URI of the value being referenced.

Returns:

this object.

fromJsonValue

public JsonReference fromJsonValue(JsonValue value)
                            throws JsonValueException

Initializes this object from a $ref JSON object value.

Parameters:

value - a JSON value containing a $ref member.

Returns:

this object.

Throws:

JsonValueException - if the specified value is malformed.

NullPointerException - if value is null.

toJsonValue

public JsonValue toJsonValue()

Returns this object as a $ref JSON object value.

Returns:

The value.