com.github.fge.jsonschema.metaschema

Class MetaSchema

java.lang.Object

com.github.fge.jsonschema.metaschema.MetaSchema

public final class MetaSchema
extends Object

Metaschema main class

This class centralizes all elements necessary to define a working metaschema. Its elements are:

• the URI of that metaschema (ie, what schemas written against that metaschema refer to using $schema;
• (optionally) a raw JSON document representing that metaschema;
• a set of keywords and format attributes.

This is the base for all metaschema customizations you might want to do, such as adding custom keywords and format attributes. You can either build a completely new metaschema (using builder() or base yourself on an already existing metaschema (using basedOn(BuiltinSchemas)).

See Also:

JsonSchemaFactory.Builder.addMetaSchema(MetaSchema, boolean), BuiltinSchemas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetaSchema.Builder

Method Summary

Methods

Modifier and Type	Method and Description
static MetaSchema.Builder	basedOn(BuiltinSchemas builtin) Return a new builder based on an existing, builtin metaschema
static MetaSchema.Builder	builder() Return a new builder for a totally empty metaschema
static MetaSchema	copyOf(BuiltinSchemas builtin) Return a complete copy of a builtin metaschema
JsonRef	getDollarSchema() Return the URI of that metaschema
Map<String,FormatAttribute>	getFormatAttributes() Return the list of format attributes for that metaschema
Map<String,SyntaxChecker>	getSyntaxCheckers() Return the list of syntax checkers for that metaschema
Map<String,Class<? extends KeywordValidator>>	getValidators() Return the list of keyword validators for that metaschema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static MetaSchema.Builder builder()

Return a new builder for a totally empty metaschema

Returns:

a MetaSchema.Builder

basedOn

public static MetaSchema.Builder basedOn(BuiltinSchemas builtin)

Return a new builder based on an existing, builtin metaschema

Parameters:

builtin - the builtin metaschema used as a base

Returns:

a MetaSchema.Builder

copyOf

public static MetaSchema copyOf(BuiltinSchemas builtin)

Return a complete copy of a builtin metaschema

Parameters:

builtin - the builtin metaschema

Returns:

a ready-to-use metaschema

getDollarSchema

public JsonRef getDollarSchema()

Return the URI of that metaschema

Returns:

the URI as a JsonRef

getValidators

public Map<String,Class<? extends KeywordValidator>> getValidators()

Return the list of keyword validators for that metaschema

Returns:

an immutable map

getSyntaxCheckers

public Map<String,SyntaxChecker> getSyntaxCheckers()

Return the list of syntax checkers for that metaschema

Returns:

an immutable map

getFormatAttributes

public Map<String,FormatAttribute> getFormatAttributes()

Return the list of format attributes for that metaschema

Returns:

an immutable map