org.apache.juneau.dto.jsonschema

Class SchemaMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<URI,Schema>

org.apache.juneau.dto.jsonschema.SchemaMap

All Implemented Interfaces:

Serializable, ConcurrentMap<URI,Schema>, Map<URI,Schema>

public abstract class SchemaMap
extends ConcurrentHashMap<URI,Schema>

A container for retrieving JSON Schema objects by URI.

Subclasses must implement one of the following methods to load schemas from external sources:

• getReader(URI) - If schemas should be loaded from readers and automatically parsed.
• load(URI) - If you want control over construction of Schema objects.

See Also:

• org.apache.juneau.dto.jsonschema

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

ConcurrentHashMap.KeySetView<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SchemaMap()

Method Summary

Modifier and Type	Method and Description
SchemaMap	add(Schema... schemas) Convenience method for pre-populating this map with the specified schemas.
Schema	get(Object uri) Return the Schema object at the specified URI.
Reader	getReader(URI uri) Subclasses must implement either this method or load(URI) to load the schema with the specified URI.
Schema	load(URI uri) Subclasses must implement either this method or getReader(URI) to load the schema with the specified URI.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaMap

public SchemaMap()

Method Detail

get

public Schema get(Object uri)

Return the Schema object at the specified URI.

If this schema object has not been loaded yet, calls load(URI).

The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

URIs defined by UriResolver can be used for values.

Specified by:

get in interface Map<URI,Schema>

Overrides:

get in class ConcurrentHashMap<URI,Schema>

Parameters:

uri - The URI of the schema to retrieve.

Returns:

The Schema, or null if schema was not located and could not be loaded.

add

public SchemaMap add(Schema... schemas)

Convenience method for pre-populating this map with the specified schemas.

The schemas passed in through this method MUST have their ID properties set.

Parameters:

schemas - The set of schemas to add to this map.

Returns:

This object (for method chaining).

Throws:

RuntimeException - If one or more schema objects did not have their ID property set.

load

public Schema load(URI uri)

Subclasses must implement either this method or getReader(URI) to load the schema with the specified URI.

It's up to the implementer to decide where these come from.

The default implementation calls getReader(URI) and parses the schema document. If getReader(URI) returns null, this method returns null indicating this is an unreachable document.

Parameters:

uri - The URI to load the schema from.

Returns:

The parsed schema.

getReader

public Reader getReader(URI uri)

Subclasses must implement either this method or load(URI) to load the schema with the specified URI.

It's up to the implementer to decide where these come from.

The default implementation returns null.

Parameters:

uri - The URI to connect to and retrieve the contents.

Returns:

The reader from reading the specified URI.