com.github.fge.jsonschema.metaschema

Enum BuiltinSchemas

java.lang.Object

java.lang.Enum<BuiltinSchemas>

com.github.fge.jsonschema.metaschema.BuiltinSchemas

All Implemented Interfaces:

Serializable, Comparable<BuiltinSchemas>

public enum BuiltinSchemas
extends Enum<BuiltinSchemas>

Enumeration of builtin metaschemas

This enum centralizes all metaschemas defined by the different JSON Schema specifications (draft v3 and draft v4).

Enum Constant Summary

Enum Constants

Enum Constant and Description
DRAFTV3_CORE Draft v3 core schema
DRAFTV3_HYPERSCHEMA Draft v3 hyper-schema
DRAFTV3_LINKS Draft v3 LDO (Link Description Object) schema
DRAFTV4_CORE Draft v4 core schema

Method Summary

Methods

Modifier and Type	Method and Description
static BuiltinSchemas	byDefault() Return the default metaschema (currently DRAFTV3_HYPERSCHEMA
JsonNode	getRawSchema() Get the raw JSON document for that schema
URI	getURI() Get the locator for this schema
String	toString()
static BuiltinSchemas	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuiltinSchemas[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DRAFTV3_CORE

public static final BuiltinSchemas DRAFTV3_CORE

Draft v3 core schema

DRAFTV4_CORE

public static final BuiltinSchemas DRAFTV4_CORE

Draft v4 core schema

DRAFTV3_LINKS

public static final BuiltinSchemas DRAFTV3_LINKS

Draft v3 LDO (Link Description Object) schema

DRAFTV3_HYPERSCHEMA

public static final BuiltinSchemas DRAFTV3_HYPERSCHEMA

Draft v3 hyper-schema

Method Detail

values

public static BuiltinSchemas[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BuiltinSchemas c : BuiltinSchemas.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuiltinSchemas valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

byDefault

public static BuiltinSchemas byDefault()

Return the default metaschema (currently DRAFTV3_HYPERSCHEMA

Returns:

a BuiltinSchemas instance

getURI

public URI getURI()

Get the locator for this schema

Returns:

the locator as a URI

getRawSchema

public JsonNode getRawSchema()

Get the raw JSON document for that schema

Returns:

the schema as a JsonNode

toString

public String toString()

Overrides:

toString in class Enum<BuiltinSchemas>