org.eel.kitchen.jsonschema.schema

Enum AddressingMode

java.lang.Object

java.lang.Enum<AddressingMode>

org.eel.kitchen.jsonschema.schema.AddressingMode

All Implemented Interfaces:

Serializable, Comparable<AddressingMode>

public enum AddressingMode
extends Enum<AddressingMode>

Schema addressing mode

JSON Schema defines the id keyword for schema identification purposes. This keyword can be used both at the schema root and in subschemas. For instance:

     {
         "id": "some://where/schema.json",
         "sub": {
             "id": "other.json"
         }
     }
 

What can happen here is that an implementation walks the schema and determines that the URI of the root schema is some://where/schema.json , which is pretty much normal. It can also see the other id in subschema /sub and resolve the value of this subschema against the root URI: this gives some://where/other.json. This is called by this implementation INLINE addressing mode.

By default, for security reasons, the addressing mode is CANONICAL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL
INLINE

Method Summary

Methods

Modifier and Type	Method and Description
SchemaContainer	forSchema(JsonNode schema)
abstract SchemaContainer	forSchema(URI uri, JsonNode schema)
static AddressingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AddressingMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANONICAL

public static final AddressingMode CANONICAL

INLINE

public static final AddressingMode INLINE

Method Detail

values

public static AddressingMode[] 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 (AddressingMode c : AddressingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AddressingMode 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

forSchema

public abstract SchemaContainer forSchema(URI uri,
                        JsonNode schema)

forSchema

public final SchemaContainer forSchema(JsonNode schema)