org.eel.kitchen.jsonschema.metaschema

Class MetaSchema.Builder

java.lang.Object

org.eel.kitchen.jsonschema.metaschema.MetaSchema.Builder

Enclosing class:

MetaSchema

public static final class MetaSchema.Builder
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
MetaSchema.Builder	addFormatAttribute(String fmt, FormatAttribute formatAttribute) Add a format attribute to the metaschema
MetaSchema.Builder	addKeyword(Keyword keyword) Add a new keyword to that metaschema
MetaSchema.Builder	addKeywordRegistry(KeywordRegistry registry) Deprecated. This is public only because JsonSchemaFactory needs it
MetaSchema	build() Build the metaschema
MetaSchema.Builder	removeFormatAttribute(String fmt) Remove a format attribute from this metaschema
MetaSchema.Builder	removeKeyword(String name) Remove a keyword from that metaschema
MetaSchema.Builder	withRawSchema(JsonNode rawSchema) Assign a JSON representation of that metaschema
MetaSchema.Builder	withURI(String uri) Set a new URI for the metaschema

Methods inherited from class java.lang.Object

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

Method Detail

withURI

public MetaSchema.Builder withURI(String uri)

Set a new URI for the metaschema

Parameters:

uri - the URI as a string

Returns:

this

Throws:

IllegalArgumentException - provided string is not a URI

withRawSchema

public MetaSchema.Builder withRawSchema(JsonNode rawSchema)

Assign a JSON representation of that metaschema

Note: correctness of the representation is not checked

Parameters:

rawSchema - the JSON

Returns:

this

addKeyword

public MetaSchema.Builder addKeyword(Keyword keyword)

Add a new keyword to that metaschema

Note: if a keyword by the same name already existed, this method overrides it completely without warning.

Parameters:

keyword - the new keyword

Returns:

this

Throws:

NullPointerException - keyword is null

removeKeyword

public MetaSchema.Builder removeKeyword(String name)

Remove a keyword from that metaschema

If the keyword did not previously exist, this operation has no effect.

Parameters:

name - the name of the keyword to rename

Returns:

this

Throws:

NullPointerException - name is null

addFormatAttribute

public MetaSchema.Builder addFormatAttribute(String fmt,
                                    FormatAttribute formatAttribute)

Add a format attribute to the metaschema

If a format attribute by that name already existed, this method overrides the previous attribute without warning.

Parameters:

fmt - the name of the attribute

formatAttribute - the implementation of the attribute

Returns:

this

Throws:

NullPointerException - the attribute name, or implementation, are null

removeFormatAttribute

public MetaSchema.Builder removeFormatAttribute(String fmt)

Remove a format attribute from this metaschema

If the format attribute did not exist previously, this method has no effect.

Parameters:

fmt - the attribute name to remove

Returns:

this

Throws:

NullPointerException - the attribute name is null

addKeywordRegistry

@Deprecated
public MetaSchema.Builder addKeywordRegistry(KeywordRegistry registry)

Deprecated. This is public only because JsonSchemaFactory needs it

Add a keyword registry to that metaschema

Parameters:

registry - the registry

Returns:

this

build

public MetaSchema build()

Build the metaschema

Returns:

a metaschema

Throws:

NullPointerException - no URI has been provided for that metaschema

IllegalArgumentException - provided URI for that metaschema is not an absolute JSON Reference