com.ibm.cos.v2.protocols.json.internal.marshall

Class JsonMarshallerContext

java.lang.Object

com.ibm.cos.v2.protocols.json.internal.marshall.JsonMarshallerContext

public final class JsonMarshallerContext
extends Object

Dependencies needed by implementations of JsonMarshaller.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonMarshallerContext.Builder Builder for a JsonMarshallerContext.

Method Summary

Modifier and Type	Method and Description
static JsonMarshallerContext.Builder	builder()
StructuredJsonGenerator	jsonGenerator()
void	marshall(MarshallLocation marshallLocation, Object val) Convenience method to marshall a nested object (may be simple or structured) at the given location.
<T> void	marshall(MarshallLocation marshallLocation, T val, String paramName) Convenience method to marshall a nested object (may be simple or structured) at the given location.
JsonMarshallerRegistry	marshallerRegistry()
JsonProtocolMarshaller	protocolHandler()
SdkHttpFullRequest.Builder	request()

Methods inherited from class java.lang.Object

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

Method Detail

jsonGenerator

public StructuredJsonGenerator jsonGenerator()

Returns:

StructuredJsonGenerator used to produce the JSON document for a request.

protocolHandler

public JsonProtocolMarshaller protocolHandler()

Returns:

Implementation of ProtocolMarshaller that can be used to call back out to marshall structured data (i.e. dlists of objects).

marshallerRegistry

public JsonMarshallerRegistry marshallerRegistry()

Returns:

Marshaller registry to obtain marshaller implementations for nested types (i.e. lists of objects or maps of string to string).

request

public SdkHttpFullRequest.Builder request()

Returns:

Mutable SdkHttpFullRequest.Builder object that can be used to add headers, query params, modify request URI, etc.

marshall

public void marshall(MarshallLocation marshallLocation,
                     Object val)

Convenience method to marshall a nested object (may be simple or structured) at the given location.

Parameters:

marshallLocation - Current MarshallLocation

val - Value to marshall.

marshall

public <T> void marshall(MarshallLocation marshallLocation,
                         T val,
                         String paramName)

Convenience method to marshall a nested object (may be simple or structured) at the given location.

Parameters:

marshallLocation - Current MarshallLocation

val - Value to marshall.

paramName - Name of parameter to marshall.

builder

public static JsonMarshallerContext.Builder builder()

Returns:

Builder instance to construct a JsonMarshallerContext.