Class SdkJsonGenerator

java.lang.Object

software.amazon.awssdk.protocols.json.SdkJsonGenerator

All Implemented Interfaces:

StructuredJsonGenerator

Direct Known Subclasses:

SdkCborGenerator, SdkRpcV2CborGenerator

@SdkProtectedApi
public class SdkJsonGenerator
extends Object
implements StructuredJsonGenerator

Thin wrapper around Jackson's JSON generator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SdkJsonGenerator.JsonGenerationException	Indicates an issue writing JSON content.

Field Summary

Fields inherited from interface software.amazon.awssdk.protocols.json.StructuredJsonGenerator

NO_OP

Constructor Summary

Constructors

Constructor	Description
SdkJsonGenerator(software.amazon.awssdk.thirdparty.jackson.core.JsonFactory factory, String contentType)

Method Summary

Modifier and Type	Method	Description
int	contentSize()	Returns the size of the generated content in bytes without copying.
ContentStreamProvider	contentStreamProvider()	Returns a ContentStreamProvider that streams directly from the internal buffers without creating a contiguous copy.
byte[]	getBytes()	Get the JSON content as a UTF-8 encoded byte array.
String	getContentType()	New clients use invalid reference SdkJsonProtocolFactory#getContentType() .
StructuredJsonGenerator	writeBinaryValue(byte[] bytes)	Writes binary data directly from a byte array, avoiding the overhead of wrapping in a ByteBuffer.
StructuredJsonGenerator	writeEndArray()
StructuredJsonGenerator	writeEndObject()
StructuredJsonGenerator	writeFieldName(String fieldName)
StructuredJsonGenerator	writeNull()
StructuredJsonGenerator	writeNumber(String number)
StructuredJsonGenerator	writeStartArray()
StructuredJsonGenerator	writeStartObject()
StructuredJsonGenerator	writeValue(boolean bool)
StructuredJsonGenerator	writeValue(byte val)
StructuredJsonGenerator	writeValue(double val)
StructuredJsonGenerator	writeValue(float val)
StructuredJsonGenerator	writeValue(int val)
StructuredJsonGenerator	writeValue(long val)
StructuredJsonGenerator	writeValue(short val)
StructuredJsonGenerator	writeValue(String val)
StructuredJsonGenerator	writeValue(BigDecimal value)
StructuredJsonGenerator	writeValue(BigInteger value)
StructuredJsonGenerator	writeValue(ByteBuffer bytes)
StructuredJsonGenerator	writeValue(Instant instant)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.protocols.json.StructuredJsonGenerator

writeStartArray

Constructor Details

SdkJsonGenerator

public SdkJsonGenerator(software.amazon.awssdk.thirdparty.jackson.core.JsonFactory factory,
 String contentType)

Method Details

writeStartArray

public StructuredJsonGenerator writeStartArray()

Specified by:

writeStartArray in interface StructuredJsonGenerator

writeEndArray

public StructuredJsonGenerator writeEndArray()

Specified by:

writeEndArray in interface StructuredJsonGenerator

writeNull

public StructuredJsonGenerator writeNull()

Specified by:

writeNull in interface StructuredJsonGenerator

writeStartObject

public StructuredJsonGenerator writeStartObject()

Specified by:

writeStartObject in interface StructuredJsonGenerator

writeEndObject

public StructuredJsonGenerator writeEndObject()

Specified by:

writeEndObject in interface StructuredJsonGenerator

writeFieldName

public StructuredJsonGenerator writeFieldName(String fieldName)

Specified by:

writeFieldName in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(String val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(boolean bool)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(long val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(double val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(float val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(byte val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(short val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(int val)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(ByteBuffer bytes)

Specified by:

writeValue in interface StructuredJsonGenerator

writeBinaryValue

public StructuredJsonGenerator writeBinaryValue(byte[] bytes)

Description copied from interface: StructuredJsonGenerator

Writes binary data directly from a byte array, avoiding the overhead of wrapping in a ByteBuffer. The default implementation wraps the array and delegates to StructuredJsonGenerator.writeValue(ByteBuffer).

Specified by:

writeBinaryValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(Instant instant)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(BigDecimal value)

Specified by:

writeValue in interface StructuredJsonGenerator

writeValue

public StructuredJsonGenerator writeValue(BigInteger value)

Specified by:

writeValue in interface StructuredJsonGenerator

writeNumber

public StructuredJsonGenerator writeNumber(String number)

Specified by:

writeNumber in interface StructuredJsonGenerator

getBytes

public byte[] getBytes()

Get the JSON content as a UTF-8 encoded byte array. It is recommended to hold onto the array reference rather then making repeated calls to this method as a new array will be created each time.

Specified by:

getBytes in interface StructuredJsonGenerator

Returns:

Array of UTF-8 encoded bytes that make up the generated JSON.

contentSize

public int contentSize()

Returns the size of the generated content in bytes without copying.

Specified by:

contentSize in interface StructuredJsonGenerator

contentStreamProvider

public ContentStreamProvider contentStreamProvider()

Returns a ContentStreamProvider that streams directly from the internal buffers without creating a contiguous copy. For small payloads this wraps the single base buffer; for large payloads it chains the base buffer and overflow chunks.

Specified by:

contentStreamProvider in interface StructuredJsonGenerator

Returns:

a content stream provider, or null if StructuredJsonGenerator.getBytes() returns null

getContentType

public String getContentType()

Description copied from interface: StructuredJsonGenerator

New clients use

invalid reference

SdkJsonProtocolFactory#getContentType()

.

Specified by:

getContentType in interface StructuredJsonGenerator