com.github.fge.jsonschema.examples

Class Example8

java.lang.Object

com.github.fge.jsonschema.examples.ExampleBase

com.github.fge.jsonschema.examples.Example8

public final class Example8
extends ExampleBase

Eighth example: augmenting schemas with custom format attributes

link to source code

link to schema

This example adds a custom format attribute named uuid, which checks whether a string instance is a valid UUID.

This kind of customization requires three steps:

• grabbing a MetaSchema.Builder;
• augmenting it as needed;
• registering it to the JsonSchemaFactory (via a JsonSchemaFactory.Builder, as for all customizations).

Here, we choose to augment the draft v3 core schema. We can base our new meta-schema by using MetaSchema.basedOn(BuiltinSchemas) with BuiltinSchemas.DRAFTV3_CORE as an argument, add our format attribute to it, build it and add it to our factory, using (MetaSchema, boolean). Note that the second argument is true so that our new meta-schema is regarded as the default.

Note also that the schema has no $schema defined; as a result, the default meta-schema is used (it is not recommended to omit $schema in your own schemas).

Adding a custom format attribute is done by extending the FormatAttribute class.

Two sample files are given: the first (link) is valid, the other (link) isn't (the provided id for the second array element is invalid).

Constructor Summary

Constructors

Constructor and Description
Example8()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String... args)

Methods inherited from class com.github.fge.jsonschema.examples.ExampleBase

loadResource, printReport

Methods inherited from class java.lang.Object

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

Constructor Detail

Example8

public Example8()

Method Detail

main

public static void main(String... args)
                 throws IOException

Throws:

IOException