com.ibm.cloud.objectstorage.protocol.json

Class SdkJsonGenerator

java.lang.Object

com.ibm.cloud.objectstorage.protocol.json.SdkJsonGenerator

All Implemented Interfaces:

StructuredJsonGenerator

public class SdkJsonGenerator
extends Object
implements StructuredJsonGenerator

Thin wrapper around Jackson's JSON generator.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface com.ibm.cloud.objectstorage.protocol.json.StructuredJsonGenerator

NO_OP

Constructor Summary

Constructors

Constructor and Description
SdkJsonGenerator(com.fasterxml.jackson.core.JsonFactory factory, String contentType)

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get the JSON content as a UTF-8 encoded byte array.
String	getContentType() New clients use SdkJsonProtocolFactory.getContentType().
protected com.fasterxml.jackson.core.JsonGenerator	getGenerator()
StructuredJsonGenerator	writeEndArray()
StructuredJsonGenerator	writeEndObject()
StructuredJsonGenerator	writeFieldName(String fieldName)
StructuredJsonGenerator	writeNull()
StructuredJsonGenerator	writeStartArray()
StructuredJsonGenerator	writeStartObject()
StructuredJsonGenerator	writeValue(BigDecimal value)
StructuredJsonGenerator	writeValue(BigInteger value)
StructuredJsonGenerator	writeValue(boolean bool)
StructuredJsonGenerator	writeValue(ByteBuffer bytes)
StructuredJsonGenerator	writeValue(Date date, TimestampFormat timestampFormat)
StructuredJsonGenerator	writeValue(double val)
StructuredJsonGenerator	writeValue(float val)
StructuredJsonGenerator	writeValue(int val)
StructuredJsonGenerator	writeValue(long val)
StructuredJsonGenerator	writeValue(short val)
StructuredJsonGenerator	writeValue(String val)

Methods inherited from class java.lang.Object

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

Constructor Detail

SdkJsonGenerator

public SdkJsonGenerator(com.fasterxml.jackson.core.JsonFactory factory,
                        String contentType)

Method Detail

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(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

writeValue

public StructuredJsonGenerator writeValue(Date date,
                                          TimestampFormat timestampFormat)

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

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.

getContentType

public String getContentType()

Description copied from interface: StructuredJsonGenerator

New clients use SdkJsonProtocolFactory.getContentType().

Specified by:

getContentType in interface StructuredJsonGenerator

getGenerator

protected com.fasterxml.jackson.core.JsonGenerator getGenerator()