org.eel.kitchen.jsonschema.ref

Class JsonRef

java.lang.Object

org.eel.kitchen.jsonschema.ref.JsonRef

public final class JsonRef
extends Object

Representation of a JSON Reference

JSON Reference, currently a draft, is a way to address a JSON instance of whatever type.

To quote the draft, "A JSON Reference is a JSON object, which contains a member named "$ref", which has a JSON string value." This string value must be a URI. Example:

     {
         "$ref": "http://example.com/example.json#/foo/bar"
     }
 

Here we choose to derive a little from the specification and calculate references from any field, not just $ref. This class is also used, for instance, to compute id.

The implementation is a wrapper over Java's URI, with the following differences:

• all URIs are normalized from the get go;
• an empty fragment is equivalent to no fragment at all, and stands for a root JSON Pointer;
• a reference is taken to be absolute if the underlying URI is absolute and it has no fragment, or an empty fragment.

Field Summary

Fields

Modifier and Type	Field and Description
private static LoadingCache<URI,JsonRef>	cache
private static JsonRef	EMPTY
private static URI	EMPTY_URI
private JsonFragment	fragment
private static URI	HASHONLY_URI
private URI	locator
private URI	uri The URI, as provided by the input arguments

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JsonRef(URI uri) The main constructor, which is private by design

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(JsonRef other)
static JsonRef	emptyRef()
boolean	equals(Object obj)
static JsonRef	fromString(String s)
static JsonRef	fromURI(URI uri)
JsonFragment	getFragment() Return this ref's fragment part as a string
URI	getRootAsURI() Return the absolute part of the underlying URI, without the fragment
int	hashCode()
boolean	isAbsolute()
boolean	isEmpty()
JsonRef	resolve(JsonRef other)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HASHONLY_URI

private static final URI HASHONLY_URI

EMPTY_URI

private static final URI EMPTY_URI

EMPTY

private static final JsonRef EMPTY

cache

private static final LoadingCache<URI,JsonRef> cache

uri

private final URI uri

The URI, as provided by the input arguments

locator

private final URI locator

fragment

private final JsonFragment fragment

Constructor Detail

JsonRef

private JsonRef(URI uri)

The main constructor, which is private by design

Parameters:

uri - Input URI

Method Detail

fromURI

public static JsonRef fromURI(URI uri)

fromString

public static JsonRef fromString(String s)
                          throws JsonSchemaException

Throws:

JsonSchemaException

emptyRef

public static JsonRef emptyRef()

isEmpty

public boolean isEmpty()

isAbsolute

public boolean isAbsolute()

resolve

public JsonRef resolve(JsonRef other)

getRootAsURI

public URI getRootAsURI()

Return the absolute part of the underlying URI, without the fragment

Returns:

an URI

getFragment

public JsonFragment getFragment()

Return this ref's fragment part as a string

If there is no fragment, an empty string is returned.

Returns:

the fragment

contains

public boolean contains(JsonRef other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object