Class JsonWriter

java.lang.Object

software.amazon.awssdk.protocols.jsoncore.JsonWriter

All Implemented Interfaces:

AutoCloseable, SdkAutoCloseable

public class JsonWriter
extends Object
implements SdkAutoCloseable

Thin wrapper around Jackson's JSON generator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonWriter.Builder	A builder for configuring and creating JsonWriter.
static class	JsonWriter.JsonGenerationException	Indicates an issue writing JSON content.
static interface	JsonWriter.JsonGeneratorFactory	Generate a JsonGenerator for a OutputStream.

Method Summary

Modifier and Type	Method	Description
static JsonWriter.Builder	builder()
void	close()	Closes the generator and flushes to write.
static JsonWriter	create()
byte[]	getBytes()	Get the JSON content as a UTF-8 encoded byte array.
JsonWriter	writeEndArray()
JsonWriter	writeEndObject()
JsonWriter	writeFieldName(String fieldName)
JsonWriter	writeNull()
JsonWriter	writeNumber(String number)
JsonWriter	writeStartArray()
JsonWriter	writeStartObject()
JsonWriter	writeValue(boolean bool)
JsonWriter	writeValue(double val)
JsonWriter	writeValue(float val)
JsonWriter	writeValue(int val)
JsonWriter	writeValue(long val)
JsonWriter	writeValue(short val)
JsonWriter	writeValue(String val)
JsonWriter	writeValue(BigDecimal value)
JsonWriter	writeValue(BigInteger value)
JsonWriter	writeValue(ByteBuffer bytes)
JsonWriter	writeValue(Instant instant)

Methods inherited from class java.lang.Object

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

Method Details

create

public static JsonWriter create()

builder

public static JsonWriter.Builder builder()

writeStartArray

public JsonWriter writeStartArray()

writeEndArray

public JsonWriter writeEndArray()

writeNull

public JsonWriter writeNull()

writeStartObject

public JsonWriter writeStartObject()

writeEndObject

public JsonWriter writeEndObject()

writeFieldName

public JsonWriter writeFieldName(String fieldName)

writeValue

public JsonWriter writeValue(String val)

writeValue

public JsonWriter writeValue(boolean bool)

writeValue

public JsonWriter writeValue(long val)

writeValue

public JsonWriter writeValue(double val)

writeValue

public JsonWriter writeValue(float val)

writeValue

public JsonWriter writeValue(short val)

writeValue

public JsonWriter writeValue(int val)

writeValue

public JsonWriter writeValue(ByteBuffer bytes)

writeValue

public JsonWriter writeValue(Instant instant)

writeValue

public JsonWriter writeValue(BigDecimal value)

writeValue

public JsonWriter writeValue(BigInteger value)

writeNumber

public JsonWriter writeNumber(String number)

close

public void close()

Closes the generator and flushes to write. Must be called when finished writing JSON content.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

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.

Returns:

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