org.eel.kitchen.jsonschema.schema.SchemaBundle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-schema-validator Show documentation

A Java implementation of the JSON Schema specification

There is a newer version: 1.5.2

Show newest version

/*
 * Copyright (c) 2012, 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 org.eel.kitchen.jsonschema.schema;

import com.fasterxml.jackson.databind.JsonNode;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import org.eel.kitchen.jsonschema.ref.JsonRef;

import java.net.URI;
import java.util.Map;

import static org.eel.kitchen.jsonschema.main.JsonSchemaFactory.*;

/**
 * A schema bundle
 *
 * You can use this class to register a set of schemas and pass it to your
 * schema factory via a builder.
 *
 * Note that URIs must be valid, absolute JSON references, which means that
 * not only the URI itself must be absolute, but also have no fragment or an
 * empty fragment.
 *
 * Note also that the validity of the schemas is not checked at this
 * stage.
 *
 * @see Builder#addSchema(URI, JsonNode)
 * @see Builder#addSchema(String, JsonNode)
 * @see SchemaRegistry#addBundle(SchemaBundle)
 */
public final class SchemaBundle
{
    /**
     * Map of schemas
     */
    private final Map schemas = Maps.newHashMap();

    /**
     * Add a schema to the bundle
     *
     * @param uri the URI of this schema
     * @param schema the schema as a JSON document
     * @throws IllegalArgumentException the URI is not an absolute JSON
     * Reference
     */
    public void addSchema(final URI uri, final JsonNode schema)
    {
        final JsonRef ref = JsonRef.fromURI(uri);
        Preconditions.checkArgument(ref.isAbsolute(),
            "provided URI " + uri + " is not an absolute schema URI");

        schemas.put(ref.getLocator(), schema);
    }

    /**
     * Add a schema to the bundle
     *
     * @param uri the URI of this schema as a string
     * @param schema the schema as a JSON document
     * @throws IllegalArgumentException {@code uri} is not a URI, or the
     * generated URI is not an absolute JSON Reference
     */
    public void addSchema(final String uri, final JsonNode schema)
    {
        addSchema(URI.create(uri), schema);
    }

    public Map getSchemas()
    {
        return ImmutableMap.copyOf(schemas);
    }
}