com.github.fge.jsonschema.tree

Class JsonSchemaTree

java.lang.Object

com.github.fge.jsonschema.tree.BaseJsonTree

com.github.fge.jsonschema.tree.JsonSchemaTree

All Implemented Interfaces:

JsonTree, AsJson

Direct Known Subclasses:

CanonicalSchemaTree, InlineSchemaTree

public abstract class JsonSchemaTree
extends BaseJsonTree

A JsonTree carrying URI resolution context information

In addition to what JsonTree does, this tree also modifies URI resolution context information when changing paths, and adds methods in order to query this resolution context.

All context information is carried as JSON References, since this is what is used for addressing in JSON Schema.

See Also:

JsonRef, CanonicalSchemaTree, InlineSchemaTree

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonRef	currentRef The current resolution context
protected JsonRef	loadingRef The JSON Reference from which this node has been loaded
protected Deque<JsonRef>	refStack The stack of resolution contexts
protected JsonRef	startingRef The JSON Reference representing the context at the root of the schema

Fields inherited from class com.github.fge.jsonschema.tree.BaseJsonTree

baseNode, currentNode, currentPointer, FACTORY, nodeStack, pointerStack

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonSchemaTree(JsonRef loadingRef, JsonNode baseNode, Dereferencing dereferencing) The main constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	append(JsonPointer ptr) Append a JSON Pointer to the current path
JsonNode	asJson()
abstract boolean	containsRef(JsonRef ref) Tell whether a JSON Reference is contained within this schema tree
JsonSchemaTree	copy() Return a copy of this tree at its current state but with an empty stack
boolean	equals(Object obj)
JsonRef	getCurrentRef() Get the current resolution context
JsonRef	getLoadingRef() Get the loading URI for that schema
int	hashCode()
protected static JsonRef	idFromNode(JsonNode node) Build a JSON Reference from a node
abstract JsonPointer	matchingPointer(JsonRef ref) Return a matching pointer in this tree for a fully resolved reference
void	pop() Reverts the last append
JsonRef	resolve(JsonRef other) Resolve a JSON Reference against the current resolution context
void	setPointer(JsonPointer pointer)
String	toString()

Methods inherited from class com.github.fge.jsonschema.tree.BaseJsonTree

getCurrentNode, getCurrentPointer, popNode, popPointer, pushNode, pushPointer

Methods inherited from class java.lang.Object

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

Field Detail

loadingRef

protected final JsonRef loadingRef

The JSON Reference from which this node has been loaded

If loaded without a URI, this will be the empty reference.

startingRef

protected final JsonRef startingRef

The JSON Reference representing the context at the root of the schema

It will defer from loadingRef if there is an id at the top level.

refStack

protected final Deque<JsonRef> refStack

The stack of resolution contexts

currentRef

protected JsonRef currentRef

The current resolution context

Constructor Detail

JsonSchemaTree

protected JsonSchemaTree(JsonRef loadingRef,
              JsonNode baseNode,
              Dereferencing dereferencing)

The main constructor

Parameters:

loadingRef - the loading reference

baseNode - the base node

Method Detail

append

public final void append(JsonPointer ptr)

Description copied from interface: JsonTree

Append a JSON Pointer to the current path

Parameters:

ptr - the pointer to append

See Also:

JsonPointer.append(JsonPointer)

pop

public final void pop()

Description copied from interface: JsonTree

Reverts the last append

Note: this operation will fail badly if you haven't appended anything, so use with care!

setPointer

public final void setPointer(JsonPointer pointer)

resolve

public final JsonRef resolve(JsonRef other)

Resolve a JSON Reference against the current resolution context

Parameters:

other - the JSON Reference to resolve

Returns:

the resolved reference

See Also:

JsonRef.resolve(JsonRef)

containsRef

public abstract boolean containsRef(JsonRef ref)

Tell whether a JSON Reference is contained within this schema tree

This method will return true if the caller can attempt to retrieve the JSON value addressed by this reference from the schema tree directly.

Note that the reference must be fully resolved for this method to work.

Parameters:

ref - the target reference

Returns:

see description

See Also:

resolve(JsonRef)

matchingPointer

public abstract JsonPointer matchingPointer(JsonRef ref)

Return a matching pointer in this tree for a fully resolved reference

This must be called only when containsRef(JsonRef) returns true. Otherwise, its result is undefined.

Parameters:

ref - the reference

Returns:

the matching pointer, or null if not found

getLoadingRef

public final JsonRef getLoadingRef()

Get the loading URI for that schema

Returns:

the loading URI as a JsonRef

getCurrentRef

public final JsonRef getCurrentRef()

Get the current resolution context

Returns:

the context as a JsonRef

copy

public final JsonSchemaTree copy()

Return a copy of this tree at its current state but with an empty stack

Returns:

the copy

idFromNode

protected static JsonRef idFromNode(JsonNode node)

Build a JSON Reference from a node

This will return null if the reference could not be built. The conditions for a successful build are as follows:

• the node is an object;
• it has a member named id;
• the value of this member is a string;
• this string is a valid URI.

Parameters:

node - the node

Returns:

a JSON Reference, or null

hashCode

public final int hashCode()

Specified by:

hashCode in class BaseJsonTree

equals

public final boolean equals(Object obj)

Specified by:

equals in class BaseJsonTree

asJson

public final JsonNode asJson()

toString

public final String toString()

Specified by:

toString in class BaseJsonTree