Package software.amazon.awssdk.protocol.json.internal

Class JsonMarshallerContext

java.lang.Object

software.amazon.awssdk.protocol.json.internal.JsonMarshallerContext

public class JsonMarshallerContext
extends Object

Dependencies needed by implemenatations of JsonMarshaller.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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.
void	marshall(MarshallLocation marshallLocation, Object val, String paramName)	Convenience method to marshall a nested object (may be simple or structured) at the given location.
MarshallerRegistry	marshallerRegistry()
ProtocolMarshaller	protocolHandler()
Request<?>	request()

Methods inherited from class java.lang.Object

equals, 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. dlists 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.

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,
                     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.