com.github.fge.jsonschema.tree

Class CanonicalSchemaTree

java.lang.Object

com.github.fge.jsonschema.tree.BaseJsonTree

com.github.fge.jsonschema.tree.JsonSchemaTree

com.github.fge.jsonschema.tree.CanonicalSchemaTree

All Implemented Interfaces:

JsonTree, AsJson

public final class CanonicalSchemaTree
extends JsonSchemaTree

A JsonSchemaTree using canonical dereferencing

When using canonical dereferencing, a (fully resolved) JSON Reference is contained within the tree if and only if:

• this reference without a fragment part is the same as this tree's loading reference without a fragment part;
• this reference's fragment part, if any, is a JSON Pointer.

See Also:

JsonSchemaTree, JsonRef.contains(JsonRef), JsonFragment.isPointer()

Field Summary

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

currentRef, loadingRef, refStack, startingRef

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

baseNode, currentNode, currentPointer, FACTORY, nodeStack, pointerStack

Constructor Summary

Constructors

Constructor and Description
CanonicalSchemaTree(JsonNode baseNode)
CanonicalSchemaTree(JsonRef loadingRef, JsonNode baseNode)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsRef(JsonRef ref) Tell whether a JSON Reference is contained within this schema tree
JsonPointer	matchingPointer(JsonRef ref) Return a matching pointer in this tree for a fully resolved reference

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

append, asJson, copy, equals, getCurrentRef, getLoadingRef, hashCode, idFromNode, pop, resolve, setPointer, 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

Constructor Detail

CanonicalSchemaTree

public CanonicalSchemaTree(JsonRef loadingRef,
                   JsonNode baseNode)

CanonicalSchemaTree

public CanonicalSchemaTree(JsonNode baseNode)

Method Detail

containsRef

public boolean containsRef(JsonRef ref)

Description copied from class: JsonSchemaTree

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.

Specified by:

containsRef in class JsonSchemaTree

Parameters:

ref - the target reference

Returns:

see description

See Also:

JsonSchemaTree.resolve(JsonRef)

matchingPointer

public JsonPointer matchingPointer(JsonRef ref)

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

Here, it is easy enough:

• if the fragment is not a JSON Pointer, no match;
• otherwise, check whether resolving the fragment yields any other node than a MissingNode.

Specified by:

matchingPointer in class JsonSchemaTree

Parameters:

ref - the reference

Returns:

the matching pointer, or null if not found