com.hound.core

Class HoundMapper

java.lang.Object

com.hound.core.HoundMapper

public class HoundMapper
extends java.lang.Object

The central interface to all hound related model objects. Typical usage is to call one of the "read" methods which will parse the given source and returns the model object.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	debug

Constructor Summary

Constructors

Constructor and Description
HoundMapper()

Method Summary

Methods

Modifier and Type	Method and Description
static HoundMapper	get() Convenience method to grab the default HoundMapper.
ObjectMapper	getObjectMapper() Don't use this unless you have to.
<T> T	read(JsonNode jsonNode, java.lang.Class<T> clazz) Converts the json node to an instance of the given class.
void	readerWarmUp(java.lang.Class<?> c) Takes the object mapper returned from getObjectMapper() and "warms up" the mapper for the given object type.
void	setDebug(boolean debug) When set to true, prints outs logs to help with debugging.
void	writerWarmUp(java.lang.Class<?> c) Takes the object mapper returned from getObjectMapper() and "warms up" the mapper for the given object type.
ObjectNode	writeValueAsNode(java.lang.Object object) Writes the given object to an com.fasterxml.jackson.databind.node.ObjectNode using the underlying object mapper.
java.lang.String	writeValueAsString(java.lang.Object object) A convenience method for writing out the object as a JSON string.

Methods inherited from class java.lang.Object

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

Field Detail

debug

public boolean debug

Constructor Detail

HoundMapper

public HoundMapper()

Method Detail

get

public static HoundMapper get()

Convenience method to grab the default HoundMapper.

Returns:

setDebug

public void setDebug(boolean debug)

When set to true, prints outs logs to help with debugging.

Parameters:

debug -

read

public <T> T read(JsonNode jsonNode,
         java.lang.Class<T> clazz)
       throws ParseException

Converts the json node to an instance of the given class.

Type Parameters:

T - the desired class

Parameters:

jsonNode - source

clazz - the desired class

Returns:

an instace of the desired class based on the source

Throws:

ParseException - if there is an error convert the given source to the class, this will be thrown

writeValueAsNode

public ObjectNode writeValueAsNode(java.lang.Object object)
                            throws java.lang.IllegalArgumentException

Writes the given object to an com.fasterxml.jackson.databind.node.ObjectNode using the underlying object mapper.

Parameters:

object - the model object

Returns:

the object represented as an com.fasterxml.jackson.databind.node.ObjectNode

Throws:

java.lang.IllegalArgumentException - if there was an error turning the object into a node.

writeValueAsString

public java.lang.String writeValueAsString(java.lang.Object object)
                                    throws java.lang.IllegalArgumentException

A convenience method for writing out the object as a JSON string.

Parameters:

object - the model object

Returns:

the object represented as a JSON String. Note, this is not pretty printed.

Throws:

java.lang.IllegalArgumentException - if there was an error turning the object into a JSON string.

getObjectMapper

public ObjectMapper getObjectMapper()

Don't use this unless you have to. Please use the read and write methods instead.

Returns:

the underlying object mapper used.

readerWarmUp

public void readerWarmUp(java.lang.Class<?> c)

Takes the object mapper returned from getObjectMapper() and "warms up" the mapper for the given object type. This is useful when deserializing large model objects as often the first call to the readValue will take 500+ ms.

Parameters:

c - the model class

writerWarmUp

public void writerWarmUp(java.lang.Class<?> c)

Takes the object mapper returned from getObjectMapper() and "warms up" the mapper for the given object type. This is useful when serializing large model objects as often the first call to the readValue will take 500+ ms.

Parameters:

c - the model class