org.jolokia.converter.json

Class JsonConvertOptions.Builder

java.lang.Object

org.jolokia.converter.json.JsonConvertOptions.Builder

Enclosing class:

JsonConvertOptions

public static class JsonConvertOptions.Builder
extends Object

Builder for constructing a convert options objects

Constructor Summary

Constructors

Constructor and Description
JsonConvertOptions.Builder() Default constructor using default hard limits
JsonConvertOptions.Builder(int pHardMaxDepth, int pHardMaxCollectionSize, int pHardMaxObjects) Constructor with hard limits.

Method Summary

Methods

Modifier and Type	Method and Description
JsonConvertOptions	build() Build the convert options and reset this builder
JsonConvertOptions.Builder	faultHandler(ValueFaultHandler pFaultHandler) Set the handler which determines what should be done when extracting of an value fails.
JsonConvertOptions.Builder	maxCollectionSize(int pMaxCollectionSize) Set the maximal size of collections when serializing collections.
JsonConvertOptions.Builder	maxDepth(int pMaxDepth) Set the maximum depth for how deep serialization should go.
JsonConvertOptions.Builder	maxObjects(int pMaxObjects) Set the maximum number of objects to serialize.
JsonConvertOptions.Builder	useAttributeFilter(boolean pUseFilter) Whether an attribute filter should be used to ignore missing attributes when a path is applied

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonConvertOptions.Builder

public JsonConvertOptions.Builder()

Default constructor using default hard limits

JsonConvertOptions.Builder

public JsonConvertOptions.Builder(int pHardMaxDepth,
                          int pHardMaxCollectionSize,
                          int pHardMaxObjects)

Constructor with hard limits. No value set later on this builder can be larger than these limits.

Parameters:

pHardMaxDepth - hard limit for maxDepth

pHardMaxCollectionSize - hard limit for maxCollectionSize

pHardMaxObjects - hard limit for maxObjects.

Method Detail

maxDepth

public JsonConvertOptions.Builder maxDepth(int pMaxDepth)

Set the maximum depth for how deep serialization should go. The number cannot be set larger than the hard limit given in the constructor

Parameters:

pMaxDepth - maximal depth when traversing an object tree during serialization.

Returns:

this builder

maxCollectionSize

public JsonConvertOptions.Builder maxCollectionSize(int pMaxCollectionSize)

Set the maximal size of collections when serializing collections. The number cannot be set larger than the hard limit given in the constructor.

Parameters:

pMaxCollectionSize - maximum size of objects returned in a serialized collection

Returns:

this builder

maxObjects

public JsonConvertOptions.Builder maxObjects(int pMaxObjects)

Set the maximum number of objects to serialize. The number cannot be set larger than the hard limit given in the constructor.

Parameters:

pMaxObjects - maximum number of objects

Returns:

this builder

faultHandler

public JsonConvertOptions.Builder faultHandler(ValueFaultHandler pFaultHandler)

Set the handler which determines what should be done when extracting of an value fails.

Parameters:

pFaultHandler - handler to use which can be either ValueFaultHandler.THROWING_VALUE_FAULT_HANDLER or ValueFaultHandler.THROWING_VALUE_FAULT_HANDLER. If argument is null, it is ignored

Returns:

this builder

useAttributeFilter

public JsonConvertOptions.Builder useAttributeFilter(boolean pUseFilter)

Whether an attribute filter should be used to ignore missing attributes when a path is applied

Parameters:

pUseFilter - if a filter should be used or not

Returns:

this builder

build

public JsonConvertOptions build()

Build the convert options and reset this builder

Returns:

the options created.