com.github.fge.jsonschema.processing

Class ProcessorMap<K,IN extends MessageProvider,OUT extends MessageProvider>

java.lang.Object

com.github.fge.jsonschema.processing.ProcessorMap<K,IN,OUT>

Type Parameters:

K - the type of keys in the map

IN - the input type of processors

OUT - the output type of processors

@NotThreadSafe
public abstract class ProcessorMap<K,IN extends MessageProvider,OUT extends MessageProvider>
extends Object

Map-based processor selector, with an optional default processor

The processor produced by this class works as follows:

• a key, of type K, is computed from the processor input, of type IN, using a Function;
• the processor then looks up this key in a Map, whose values are Processors;
• if the key exists, the appropriate procesor is executed; otherwise, the default action is performed.

The default action depends on whether a default processor has been supplied: if none exists, a ProcessingException is thrown.

This class is meant to be extended, and the only method to implement is f(), which provides the function to compute keys.

Note that while this class is not thread safe, the resulting processor is immutable.

Also note that null keys are not allowed.

Constructor Summary

Constructors

Constructor and Description
ProcessorMap()

Method Summary

Methods

Modifier and Type	Method and Description
ProcessorMap<K,IN,OUT>	addEntry(K key, Processor<IN,OUT> processor) Add an entry to the processor map
protected abstract Function<IN,K>	f() Provide the function to compute a key out of an input
Processor<IN,OUT>	getProcessor() Build the resulting processor from this map selector
ProcessorMap<K,IN,OUT>	setDefaultProcessor(Processor<IN,OUT> defaultProcessor) Set the default processor if no matching key is found

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorMap

public ProcessorMap()

Method Detail

addEntry

public final ProcessorMap<K,IN,OUT> addEntry(K key,
                              Processor<IN,OUT> processor)

Add an entry to the processor map

Parameters:

key - the key to match against

processor - the processor for that key

Returns:

this

Throws:

ProcessorBuildError - either the key or the processor are null

setDefaultProcessor

public final ProcessorMap<K,IN,OUT> setDefaultProcessor(Processor<IN,OUT> defaultProcessor)

Set the default processor if no matching key is found

Parameters:

defaultProcessor - the default processor

Returns:

this

Throws:

ProcessorBuildError - processor is null

getProcessor

public final Processor<IN,OUT> getProcessor()

Build the resulting processor from this map selector

The resulting processor is immutable: reusing a map builder after getting the processor by calling this method will not alter the processor you grabbed.

Returns:

the processor for this map selector

Throws:

ProcessorBuildError - the function (provided by f()) is null

f

protected abstract Function<IN,K> f()

Provide the function to compute a key out of an input

Returns:

the function