Package software.amazon.awssdk.protocols.xml.internal.marshall

Class XmlMarshallerContext

java.lang.Object

software.amazon.awssdk.protocols.xml.internal.marshall.XmlMarshallerContext

public final class XmlMarshallerContext
extends Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
XmlMarshallerContext(XmlMarshallerContext.Builder builder)

Method Summary

Modifier and Type	Method	Description
static XmlMarshallerContext.Builder	builder()
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, SdkField<T> sdkField)	Convenience method to marshall a nested object (may be simple or structured) at the given location.
XmlMarshallerRegistry	marshallerRegistry()
XmlProtocolMarshaller	protocolMarshaller()
SdkHttpFullRequest.Builder	request()
XmlGenerator	xmlGenerator()

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlMarshallerContext

public XmlMarshallerContext(XmlMarshallerContext.Builder builder)

Method Detail

xmlGenerator

public XmlGenerator xmlGenerator()

protocolMarshaller

public XmlProtocolMarshaller protocolMarshaller()

marshallerRegistry

public XmlMarshallerRegistry 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,
                         SdkField<T> sdkField)

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.

sdkField - SdkField containing metadata about the member being marshalled.

builder

public static XmlMarshallerContext.Builder builder()

Returns:

Builder instance to construct a XmlMarshallerContext.