org.jolokia.converter.json

Class ObjectToJsonConverter

java.lang.Object

org.jolokia.converter.json.ObjectToJsonConverter

public final class ObjectToJsonConverter
extends Object

A converter which converts attribute and return values into a JSON representation. It uses certain handlers for this which are registered in the constructor. Each handler gets a reference to this converter object so that it can use it for a recursive solution of nested objects.

Since:

Apr 19, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
ObjectToJsonConverter(StringToObjectConverter pStringToObjectConverter, Extractor... pSimplifyHandlers) New object-to-json converter

Method Summary

Methods

Modifier and Type	Method and Description
Object	convertToJson(Object pValue, List<String> pPathParts, JsonConvertOptions pOptions) Convert the return value to a JSON object.
Object	extractObject(Object pValue, Stack<String> pPathParts, boolean pJsonify) Related to extractObjectWithContext(java.lang.Object, java.util.Stack<java.lang.String>, org.jolokia.converter.json.JsonConvertOptions, boolean) except that it does not setup a context.
ValueFaultHandler	getValueFaultHandler() Get the fault handler used for dealing with exceptions during value extraction.
Object	setInnerValue(Object pOuterObject, Object pNewValue, List<String> pPathParts) Set an inner value of a complex object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectToJsonConverter

public ObjectToJsonConverter(StringToObjectConverter pStringToObjectConverter,
                     Extractor... pSimplifyHandlers)

New object-to-json converter

Parameters:

pStringToObjectConverter - used when setting values

pSimplifyHandlers - a bunch of simplifiers used for mangling the conversion result

Method Detail

convertToJson

public Object convertToJson(Object pValue,
                   List<String> pPathParts,
                   JsonConvertOptions pOptions)
                     throws AttributeNotFoundException

Convert the return value to a JSON object.

Parameters:

pValue - the value to convert

pPathParts - path parts to use for extraction

pOptions - options used for parsing

Returns:

the converter object. This either a subclass of JSONAware or a basic data type like String or Long.

Throws:

AttributeNotFoundException - if within an path an attribute could not be found

setInnerValue

public Object setInnerValue(Object pOuterObject,
                   Object pNewValue,
                   List<String> pPathParts)
                     throws AttributeNotFoundException,
                            IllegalAccessException,
                            InvocationTargetException

Set an inner value of a complex object. A given path must point to the attribute/index to set within the outer object.

Parameters:

pOuterObject - the object to dive in

pNewValue - the value to set

pPathParts - the path within the outer object. This object will be modified and be a modifiable list.

Returns:

the old value

Throws:

AttributeNotFoundException

IllegalAccessException

InvocationTargetException

extractObject

public Object extractObject(Object pValue,
                   Stack<String> pPathParts,
                   boolean pJsonify)
                     throws AttributeNotFoundException

Related to extractObjectWithContext(java.lang.Object, java.util.Stack<java.lang.String>, org.jolokia.converter.json.JsonConvertOptions, boolean) except that it does not setup a context. This method is called back from the various extractors to recursively continue the extraction, hence it is public. This method must not be used as entry point for serialization. Use convertToJson(Object, List, JsonConvertOptions) or setInnerValue(Object, Object, List) instead.

Parameters:

pValue - value to extract from

pPathParts - stack for diving into the object

pJsonify - whether a JSON representation JSONObject

Returns:

extracted object either in native format or as JSONObject

Throws:

AttributeNotFoundException - if an attribute is not found during traversal

getValueFaultHandler

public ValueFaultHandler getValueFaultHandler()

Get the fault handler used for dealing with exceptions during value extraction.

Returns:

the fault handler