com.ibm.cloud.objectstorage.protocol.json.internal

Class JsonMarshallerContext

java.lang.Object

com.ibm.cloud.objectstorage.protocol.json.internal.JsonMarshallerContext

public 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()
EmptyBodyJsonMarshaller	emptyBodyJsonMarshaller()
StructuredJsonGenerator	jsonGenerator()
void	marshall(MarshallLocation marshallLocation, Object val) Convenience method to marshall a nested object (may be simple or structured) at the given location.
void	marshall(MarshallLocation marshallLocation, Object val, MarshallingInfo marshallingInfo) Convenience method to marshall a nested object (may be simple or structured) at the given location.
void	marshall(MarshallLocation marshallLocation, Object val, String paramName)
MarshallerRegistry	marshallerRegistry()
ProtocolMarshaller	protocolHandler()
Request<?>	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 ProtocolMarshaller protocolHandler()

Returns:

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

marshallerRegistry

public MarshallerRegistry marshallerRegistry()

Returns:

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

request

public Request<?> request()

Returns:

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

emptyBodyJsonMarshaller

public EmptyBodyJsonMarshaller emptyBodyJsonMarshaller()

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 void marshall(MarshallLocation marshallLocation,
                     Object val,
                     MarshallingInfo marshallingInfo)

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

Parameters:

marshallLocation - Current MarshallLocation

val - Value to marshall.

marshallingInfo - Name of parameter to marshall.

marshall

public void marshall(MarshallLocation marshallLocation,
                     Object val,
                     String paramName)

builder

public static JsonMarshallerContext.Builder builder()

Returns:

Builder instance to construct a JsonMarshallerContext.