Interface StructuredJsonGenerator

All Known Implementing Classes:

SdkCborGenerator, SdkJsonGenerator, SdkRpcV2CborGenerator

@SdkProtectedApi
public interface StructuredJsonGenerator

Interface for generating a JSON

Field Summary

Fields

Modifier and Type	Field	Description
static final StructuredJsonGenerator	NO_OP	No-op implementation that ignores all calls and returns empty bytes from getBytes.

Method Summary

Modifier and Type	Method	Description
default int	contentSize()	Returns the size of the generated content in bytes without copying.
default ContentStreamProvider	contentStreamProvider()	Returns a ContentStreamProvider that streams the generated content.
byte[]	getBytes()
String	getContentType()	Deprecated.
default 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()
default StructuredJsonGenerator	writeStartArray(int size)
StructuredJsonGenerator	writeStartObject()
StructuredJsonGenerator	writeValue(boolean bool)
default 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)

Field Details

NO_OP

static final StructuredJsonGenerator NO_OP

No-op implementation that ignores all calls and returns empty bytes from getBytes.

Method Details

writeStartArray

StructuredJsonGenerator writeStartArray()

writeStartArray

default StructuredJsonGenerator writeStartArray(int size)

writeEndArray

StructuredJsonGenerator writeEndArray()

writeNull

StructuredJsonGenerator writeNull()

writeStartObject

StructuredJsonGenerator writeStartObject()

writeEndObject

StructuredJsonGenerator writeEndObject()

writeFieldName

StructuredJsonGenerator writeFieldName(String fieldName)

writeValue

StructuredJsonGenerator writeValue(String val)

writeValue

StructuredJsonGenerator writeValue(boolean bool)

writeValue

StructuredJsonGenerator writeValue(long val)

writeValue

StructuredJsonGenerator writeValue(double val)

writeValue

StructuredJsonGenerator writeValue(float val)

writeValue

StructuredJsonGenerator writeValue(short val)

writeValue

default StructuredJsonGenerator writeValue(byte val)

writeValue

StructuredJsonGenerator writeValue(int val)

writeValue

StructuredJsonGenerator writeValue(ByteBuffer bytes)

writeBinaryValue

default StructuredJsonGenerator writeBinaryValue(byte[] bytes)

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 writeValue(ByteBuffer).

writeValue

StructuredJsonGenerator writeValue(Instant instant)

writeNumber

StructuredJsonGenerator writeNumber(String number)

writeValue

StructuredJsonGenerator writeValue(BigDecimal value)

writeValue

StructuredJsonGenerator writeValue(BigInteger value)

getBytes

byte[] getBytes()

getContentType

@Deprecated
String getContentType()

Deprecated.

New clients use

invalid reference

SdkJsonProtocolFactory#getContentType()

.

contentSize

default int contentSize()

Returns the size of the generated content in bytes without copying. The default implementation falls back to getBytes().length.

contentStreamProvider

default ContentStreamProvider contentStreamProvider()

Returns a ContentStreamProvider that streams the generated content. The default implementation wraps the result of getBytes() in a ByteArrayInputStream. Implementations may override this to stream directly from internal buffers without copying.

Returns:

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