com.github.fge.jsonschema.tree.CanonicalSchemaTree Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013, Francis Galiegue 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Lesser GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Lesser GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.github.fge.jsonschema.tree;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.MissingNode;
import com.github.fge.jsonschema.processing.ref.Dereferencing;
import com.github.fge.jsonschema.ref.JsonFragment;
import com.github.fge.jsonschema.ref.JsonPointer;
import com.github.fge.jsonschema.ref.JsonRef;

/**
 * A {@link 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 JsonSchemaTree
 * @see JsonRef#contains(JsonRef)
 * @see JsonFragment#isPointer()
 */
public final class CanonicalSchemaTree
    extends JsonSchemaTree
{
    public CanonicalSchemaTree(final JsonRef loadingRef,
        final JsonNode baseNode)
    {
        super(loadingRef, baseNode, Dereferencing.CANONICAL);
    }

    public CanonicalSchemaTree(final JsonNode baseNode)
    {
        this(JsonRef.emptyRef(), baseNode);
    }

    @Override
    public boolean containsRef(final JsonRef ref)
    {
        return loadingRef.contains(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 {@link MissingNode}.
     * 
     *
     * @param ref the reference
     * @return the matching pointer, or {@code null} if not found
     */
    @Override
    public JsonPointer matchingPointer(final JsonRef ref)
    {
        final JsonFragment fragment = ref.getFragment();

        return fragment.resolve(baseNode).isMissingNode()
            ? null : (JsonPointer) fragment;
    }
}