io.qubite.tomoko.jackson

Class JacksonTomoko

java.lang.Object

io.qubite.tomoko.jackson.JacksonTomoko

public class JacksonTomoko
extends Object

Central Tomoko library facade specialized for use with Jackson. Quick and easy way to access all important elements.

Method Summary

Modifier and Type	Method and Description
<T> SpecificationDescriptor<T>	descriptorFor(Class<T> specificationClass) Used to retrieve descriptors for handlers found in the provided class.
static JacksonTomoko	instance() Creates a new JacksonTomoko instance using a default ObjectMapper.
static JacksonTomoko	instance(com.fasterxml.jackson.databind.ObjectMapper mapper) Creates a new JacksonTomoko instance using the provided mapper.
static JacksonTomoko	instance(TomokoConfigurationBuilder configurationBuilder) Creates a new JacksonTomoko instance using the provided configuration as the basis.
static JacksonTomoko	instance(TomokoConfigurationBuilder configurationBuilder, com.fasterxml.jackson.databind.ObjectMapper mapper) Creates a new JacksonTomoko instance using the provided configuration as the basis.
Patcher	patcher(PatcherTreeSpecification specification) Scans the target object and registers all properly annotated handlers.
PatchParser	patchParser()
PatcherTreeSpecification	scanHandlerTree(Object specification) Scans the target object and registers all properly annotated handlers.
Patcher	scanPatcher(Object specification) Converts a handler tree model to a patcher.
HandlerConfigurationDSL	specificationDsl() Allows registering handlers programmatically in a type-safe way.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static JacksonTomoko instance()

Creates a new JacksonTomoko instance using a default ObjectMapper. Automatically registers the JacksonTreeParser instance.

Returns:

instance

public static JacksonTomoko instance(com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a new JacksonTomoko instance using the provided mapper. Automatically registers the JacksonTreeParser instance.

Parameters:

mapper -

Returns:

instance

public static JacksonTomoko instance(TomokoConfigurationBuilder configurationBuilder)

Creates a new JacksonTomoko instance using the provided configuration as the basis. Automatically registers the JacksonTreeParser instance.

Parameters:

configurationBuilder -

Returns:

instance

public static JacksonTomoko instance(TomokoConfigurationBuilder configurationBuilder,
                                     com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a new JacksonTomoko instance using the provided configuration as the basis. Automatically registers the JacksonTreeParser instance using the provided mapper.

Parameters:

configurationBuilder -

mapper -

Returns:

specificationDsl

public HandlerConfigurationDSL specificationDsl()

Allows registering handlers programmatically in a type-safe way.

Returns:

See Also:

io.qubite.tomoko.specification.dsl

scanHandlerTree

public PatcherTreeSpecification scanHandlerTree(Object specification)

Scans the target object and registers all properly annotated handlers.

Parameters:

specification -

Returns:

handler tree model

patcher

public Patcher patcher(PatcherTreeSpecification specification)

Scans the target object and registers all properly annotated handlers.

Parameters:

specification -

Returns:

patcher ready to be used

scanPatcher

public Patcher scanPatcher(Object specification)

Converts a handler tree model to a patcher.

Parameters:

specification -

Returns:

descriptorFor

public <T> SpecificationDescriptor<T> descriptorFor(Class<T> specificationClass)

Used to retrieve descriptors for handlers found in the provided class. Allows for type-safe patch creation.

Type Parameters:

T -

Parameters:

specificationClass - class with methods annotated as handlers

Returns:

patchParser

public PatchParser patchParser()