com.github.fge.jsonschema.tree

Class InlineSchemaTree

java.lang.Object

com.github.fge.jsonschema.tree.BaseJsonTree

com.github.fge.jsonschema.tree.JsonSchemaTree

com.github.fge.jsonschema.tree.InlineSchemaTree

All Implemented Interfaces:

JsonTree, AsJson

public final class InlineSchemaTree
extends JsonSchemaTree

A JsonSchemaTree using inline dereferencing

When using inline dereferencing, a (fully resolved) reference is contained within the tree if it is relative to one of the URI resolution contexts in this tree, or to the loading URI itself.

And this makes things quite hairy to handle. Consider, for instance, that foo://bar#/a/b/c is contained within such a tree if the tree has a resolution context with URI foo://bar#/a/b!

This implementaiton correctly handles this kind of corner cases. For resolution contexts whose fragment part is not a JSON Pointer, an exact reference equality is required.

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
InlineSchemaTree(JsonNode baseNode)
InlineSchemaTree(JsonRef loadingRef, JsonNode baseNode)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsRef(JsonRef ref) Tell whether a full resolved reference is contained within this 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

InlineSchemaTree

public InlineSchemaTree(JsonRef loadingRef,
                JsonNode baseNode)

InlineSchemaTree

public InlineSchemaTree(JsonNode baseNode)

Method Detail

containsRef

public boolean containsRef(JsonRef ref)

Tell whether a full resolved reference is contained within this tree

Given the pecularity of inline dereferencing, this operation is not as simple as for canonical trees. The algorithm is as follows:

• if the fragment part of the target reference is not a JSON Pointer, only non JSON Pointer resolution contexts are considered, and return true if and only if an exact match is found, false otherwise;
• at this point, we know the fragment part is a JSON Pointer; compare the reference without a fragment part to all "JSON Pointer enabled" resolution contexts, without a fragment part: if there is no match, return false;
• on a match, return true if the JSON Pointer of the matched context is a parent of the ref's JSON Pointer.

Specified by:

containsRef in class JsonSchemaTree

Parameters:

ref - the target reference

Returns:

see description

See Also:

JsonPointer.isParentOf(JsonPointer)

matchingPointer

public JsonPointer matchingPointer(JsonRef ref)

Description copied from class: JsonSchemaTree

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

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

Specified by:

matchingPointer in class JsonSchemaTree

Parameters:

ref - the reference

Returns:

the matching pointer, or null if not found