com.fasterxml.jackson.dataformat.smile
Class SmileGenerator

java.lang.Object
  com.fasterxml.jackson.core.JsonGenerator
      com.fasterxml.jackson.core.base.GeneratorBase
          com.fasterxml.jackson.dataformat.smile.SmileGenerator

All Implemented Interfaces:

Versioned, Closeable

public class SmileGenerator
extends GeneratorBase

JsonGenerator implementation for the experimental "Binary JSON Infoset".

Author:

tatu

Nested Class Summary

static class	SmileGenerator.Feature Enumeration that defines all togglable features for Smile generators.
protected static class	SmileGenerator.SharedStringNode Helper class used for keeping track of possibly shareable String references (for field names and/or short String values)

Field Summary

protected boolean	_bufferRecyclable Flag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.
protected int	_bytesWritten Let's keep track of how many bytes have been output, may prove useful when debugging.
protected char[]	_charBuffer Intermediate buffer in which characters of a String are copied before being encoded.
protected int	_charBufferLength
protected IOContext	_ioContext
protected OutputStream	_out
protected byte[]	_outputBuffer Intermediate buffer in which contents are buffered before being written using _out.
protected int	_outputEnd Offset to index after the last valid index in _outputBuffer.
protected int	_outputTail Pointer to the next available byte in _outputBuffer
protected int	_seenNameCount Number of entries in _seenNames; -1 if no shared name detection is enabled
protected SmileGenerator.SharedStringNode[]	_seenNames Raw data structure used for checking whether field name to write can be output using back reference or not.
protected int	_seenStringValueCount Number of entries in _seenStringValues; -1 if no shared text value detection is enabled
protected SmileGenerator.SharedStringNode[]	_seenStringValues Raw data structure used for checking whether String value to write can be output using back reference or not.
protected SmileBufferRecycler<SmileGenerator.SharedStringNode>	_smileBufferRecycler Helper object used for low-level recycling of Smile-generator specific buffers.
protected int	_smileFeatures Bit flag composed of bits that indicate which SmileGenerator.Features are enabled.
protected static ThreadLocal<SoftReference<SmileBufferRecycler<SmileGenerator.SharedStringNode>>>	_smileRecyclerRef This ThreadLocal contains a SoftRerefence to a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.
protected static long	MAX_INT_AS_LONG
protected static long	MIN_INT_AS_LONG
protected static int	SURR1_FIRST
protected static int	SURR1_LAST
protected static int	SURR2_FIRST
protected static int	SURR2_LAST
protected static byte	TOKEN_BYTE_BIG_DECIMAL
protected static byte	TOKEN_BYTE_BIG_INTEGER
protected static byte	TOKEN_BYTE_FLOAT_32
protected static byte	TOKEN_BYTE_FLOAT_64
protected static byte	TOKEN_BYTE_INT_32
protected static byte	TOKEN_BYTE_INT_64
protected static byte	TOKEN_BYTE_LONG_STRING_ASCII
protected static byte	TOKEN_BYTE_LONG_STRING_UNICODE

Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase

_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

_cfgPrettyPrinter

Constructor Summary

SmileGenerator(IOContext ctxt, int jsonFeatures, int smileFeatures, ObjectCodec codec, OutputStream out)

SmileGenerator(IOContext ctxt, int jsonFeatures, int smileFeatures, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int offset, boolean bufferRecyclable)

Method Summary

protected void	_flushBuffer()
protected UnsupportedOperationException	_notSupported()
protected void	_releaseBuffers()
protected static SmileBufferRecycler<SmileGenerator.SharedStringNode>	_smileBufferRecycler()
protected void	_verifyValueWrite(String typeMsg)
protected void	_write7BitBinaryWithLength(byte[] data, int offset, int len)
protected void	_writeFieldName(SerializableString name)
protected void	_writeFieldNameUnicode(SerializableString name, byte[] bytes)
void	close()
SmileGenerator	configure(SmileGenerator.Feature f, boolean state)
SmileGenerator	disable(SmileGenerator.Feature f)
SmileGenerator	enable(SmileGenerator.Feature f)
void	flush()
Object	getOutputTarget()
boolean	isEnabled(SmileGenerator.Feature f)
protected long	outputOffset() Method for accessing offset of the next byte within the whole output stream that this generator has produced.
JsonGenerator	setPrettyPrinter(PrettyPrinter pp) No way (or need) to indent anything, so let's block any attempts.
JsonGenerator	useDefaultPrettyPrinter() No way (or need) to indent anything, so let's block any attempts.
Version	version()
void	writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
void	writeBoolean(boolean state)
void	writeBytes(byte[] data, int offset, int len) Method for directly inserting specified bytes in output at current position.
void	writeEndArray()
void	writeEndObject()
void	writeFieldName(SerializableString name)
void	writeFieldName(String name)
void	writeHeader() Method that can be called to explicitly write Smile document header.
void	writeNull()
void	writeNumber(BigDecimal dec)
void	writeNumber(BigInteger v)
void	writeNumber(double d)
void	writeNumber(float f)
void	writeNumber(int i)
void	writeNumber(long l)
void	writeNumber(String encodedValue)
void	writeRaw(byte b) Method for directly inserting specified byte in output at current position.
void	writeRaw(char c)
void	writeRaw(char[] text, int offset, int len)
void	writeRaw(String text)
void	writeRaw(String text, int offset, int len)
void	writeRawUTF8String(byte[] text, int offset, int len)
void	writeRawValue(char[] text, int offset, int len)
void	writeRawValue(String text)
void	writeRawValue(String text, int offset, int len)
void	writeStartArray()
void	writeStartObject()
void	writeString(char[] text, int offset, int len)
void	writeString(SerializableString sstr)
void	writeString(String text)
void	writeStringField(String fieldName, String value)
void	writeUTF8String(byte[] text, int offset, int len)

Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase

_cantHappen, _reportError, _reportUnsupportedOperation, _throwInternal, _writeSimpleObject, copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, writeObject, writeTree

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

canUseSchema, configure, getCharacterEscapes, getHighestEscapedChar, getSchema, setCharacterEscapes, setHighestNonEscapedChar, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_BYTE_LONG_STRING_ASCII

protected static final byte TOKEN_BYTE_LONG_STRING_ASCII

See Also:

Constant Field Values

TOKEN_BYTE_LONG_STRING_UNICODE

protected static final byte TOKEN_BYTE_LONG_STRING_UNICODE

See Also:

Constant Field Values

TOKEN_BYTE_INT_32

protected static final byte TOKEN_BYTE_INT_32

See Also:

Constant Field Values

TOKEN_BYTE_INT_64

protected static final byte TOKEN_BYTE_INT_64

See Also:

Constant Field Values

TOKEN_BYTE_BIG_INTEGER

protected static final byte TOKEN_BYTE_BIG_INTEGER

See Also:

Constant Field Values

TOKEN_BYTE_FLOAT_32

protected static final byte TOKEN_BYTE_FLOAT_32

See Also:

Constant Field Values

TOKEN_BYTE_FLOAT_64

protected static final byte TOKEN_BYTE_FLOAT_64

See Also:

Constant Field Values

TOKEN_BYTE_BIG_DECIMAL

protected static final byte TOKEN_BYTE_BIG_DECIMAL

See Also:

Constant Field Values

SURR1_FIRST

protected static final int SURR1_FIRST

See Also:

Constant Field Values

SURR1_LAST

protected static final int SURR1_LAST

See Also:

Constant Field Values

SURR2_FIRST

protected static final int SURR2_FIRST

See Also:

Constant Field Values

SURR2_LAST

protected static final int SURR2_LAST

See Also:

Constant Field Values

MIN_INT_AS_LONG

protected static final long MIN_INT_AS_LONG

See Also:

Constant Field Values

MAX_INT_AS_LONG

protected static final long MAX_INT_AS_LONG

See Also:

Constant Field Values

_ioContext

protected final IOContext _ioContext

_out

protected final OutputStream _out

_smileFeatures

protected int _smileFeatures

Bit flag composed of bits that indicate which SmileGenerator.Features are enabled.

_smileBufferRecycler

protected final SmileBufferRecycler<SmileGenerator.SharedStringNode> _smileBufferRecycler

Helper object used for low-level recycling of Smile-generator specific buffers.

_outputBuffer

protected byte[] _outputBuffer

Intermediate buffer in which contents are buffered before being written using _out.

_outputTail

protected int _outputTail

Pointer to the next available byte in _outputBuffer

_outputEnd

protected final int _outputEnd

Offset to index after the last valid index in _outputBuffer. Typically same as length of the buffer.

_charBuffer

protected char[] _charBuffer

Intermediate buffer in which characters of a String are copied before being encoded.

_charBufferLength

protected final int _charBufferLength

_bytesWritten

protected int _bytesWritten

Let's keep track of how many bytes have been output, may prove useful when debugging. This does not include bytes buffered in the output buffer, just bytes that have been written using underlying stream writer.

_seenNames

protected SmileGenerator.SharedStringNode[] _seenNames

Raw data structure used for checking whether field name to write can be output using back reference or not.

_seenNameCount

protected int _seenNameCount

Number of entries in _seenNames; -1 if no shared name detection is enabled

_seenStringValues

protected SmileGenerator.SharedStringNode[] _seenStringValues

Raw data structure used for checking whether String value to write can be output using back reference or not.

_seenStringValueCount

protected int _seenStringValueCount

Number of entries in _seenStringValues; -1 if no shared text value detection is enabled

_bufferRecyclable

protected boolean _bufferRecyclable

Flag that indicates whether the output buffer is recycable (and needs to be returned to recycler once we are done) or not.

_smileRecyclerRef

protected static final ThreadLocal<SoftReference<SmileBufferRecycler<SmileGenerator.SharedStringNode>>> _smileRecyclerRef

This ThreadLocal contains a SoftRerefence to a buffer recycler used to provide a low-cost buffer recycling for Smile-specific buffers.

Constructor Detail

SmileGenerator

public SmileGenerator(IOContext ctxt,
                      int jsonFeatures,
                      int smileFeatures,
                      ObjectCodec codec,
                      OutputStream out)

SmileGenerator

public SmileGenerator(IOContext ctxt,
                      int jsonFeatures,
                      int smileFeatures,
                      ObjectCodec codec,
                      OutputStream out,
                      byte[] outputBuffer,
                      int offset,
                      boolean bufferRecyclable)

Method Detail

writeHeader

public void writeHeader()
                 throws IOException

Method that can be called to explicitly write Smile document header. Note that usually you do not need to call this for first document to output, but rather only if you intend to write multiple root-level documents with same generator (and even in that case this is optional thing to do). As a result usually only SmileFactory calls this method.

Throws:

IOException

_smileBufferRecycler

protected static final SmileBufferRecycler<SmileGenerator.SharedStringNode> _smileBufferRecycler()

version

public Version version()

Specified by:

version in interface Versioned

Overrides:

version in class GeneratorBase

useDefaultPrettyPrinter

public JsonGenerator useDefaultPrettyPrinter()

No way (or need) to indent anything, so let's block any attempts. (should we throw an exception instead?)

Overrides:

useDefaultPrettyPrinter in class GeneratorBase

setPrettyPrinter

public JsonGenerator setPrettyPrinter(PrettyPrinter pp)

No way (or need) to indent anything, so let's block any attempts. (should we throw an exception instead?)

Overrides:

setPrettyPrinter in class JsonGenerator

getOutputTarget

public Object getOutputTarget()

Overrides:

getOutputTarget in class JsonGenerator

writeFieldName

public final void writeFieldName(String name)
                          throws IOException,
                                 JsonGenerationException

Specified by:

writeFieldName in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeFieldName

public final void writeFieldName(SerializableString name)
                          throws IOException,
                                 JsonGenerationException

Overrides:

writeFieldName in class GeneratorBase

Throws:

IOException

JsonGenerationException

writeStringField

public final void writeStringField(String fieldName,
                                   String value)
                            throws IOException,
                                   JsonGenerationException

Overrides:

writeStringField in class JsonGenerator

Throws:

IOException

JsonGenerationException

enable

public SmileGenerator enable(SmileGenerator.Feature f)

disable

public SmileGenerator disable(SmileGenerator.Feature f)

isEnabled

public final boolean isEnabled(SmileGenerator.Feature f)

configure

public SmileGenerator configure(SmileGenerator.Feature f,
                                boolean state)

writeRaw

public void writeRaw(byte b)
              throws IOException,
                     JsonGenerationException

Method for directly inserting specified byte in output at current position.

NOTE: only use this method if you really know what you are doing.

Throws:

IOException

JsonGenerationException

writeBytes

public void writeBytes(byte[] data,
                       int offset,
                       int len)
                throws IOException

Method for directly inserting specified bytes in output at current position.

NOTE: only use this method if you really know what you are doing.

Throws:

IOException

writeStartArray

public final void writeStartArray()
                           throws IOException,
                                  JsonGenerationException

Specified by:

writeStartArray in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeEndArray

public final void writeEndArray()
                         throws IOException,
                                JsonGenerationException

Specified by:

writeEndArray in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeStartObject

public final void writeStartObject()
                            throws IOException,
                                   JsonGenerationException

Specified by:

writeStartObject in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeEndObject

public final void writeEndObject()
                          throws IOException,
                                 JsonGenerationException

Specified by:

writeEndObject in class JsonGenerator

Throws:

IOException

JsonGenerationException

_writeFieldName

protected final void _writeFieldName(SerializableString name)
                              throws IOException,
                                     JsonGenerationException

Throws:

IOException

JsonGenerationException

_writeFieldNameUnicode

protected final void _writeFieldNameUnicode(SerializableString name,
                                            byte[] bytes)
                                     throws IOException,
                                            JsonGenerationException

Throws:

IOException

JsonGenerationException

writeString

public void writeString(String text)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeString in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeString

public void writeString(char[] text,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeString in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeString

public final void writeString(SerializableString sstr)
                       throws IOException,
                              JsonGenerationException

Overrides:

writeString in class GeneratorBase

Throws:

IOException

JsonGenerationException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                               int offset,
                               int len)
                        throws IOException,
                               JsonGenerationException

Specified by:

writeRawUTF8String in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeUTF8String

public final void writeUTF8String(byte[] text,
                                  int offset,
                                  int len)
                           throws IOException,
                                  JsonGenerationException

Specified by:

writeUTF8String in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeRaw

public void writeRaw(String text)
              throws IOException,
                     JsonGenerationException

Specified by:

writeRaw in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeRaw

public void writeRaw(String text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException

Specified by:

writeRaw in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeRaw

public void writeRaw(char[] text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException

Specified by:

writeRaw in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeRaw

public void writeRaw(char c)
              throws IOException,
                     JsonGenerationException

Specified by:

writeRaw in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeRawValue

public void writeRawValue(String text)
                   throws IOException,
                          JsonGenerationException

Overrides:

writeRawValue in class GeneratorBase

Throws:

IOException

JsonGenerationException

writeRawValue

public void writeRawValue(String text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException

Overrides:

writeRawValue in class GeneratorBase

Throws:

IOException

JsonGenerationException

writeRawValue

public void writeRawValue(char[] text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException

Overrides:

writeRawValue in class GeneratorBase

Throws:

IOException

JsonGenerationException

writeBinary

public void writeBinary(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeBinary in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException,
                         JsonGenerationException

Specified by:

writeBoolean in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNull

public void writeNull()
               throws IOException,
                      JsonGenerationException

Specified by:

writeNull in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(int i)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(long l)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(BigInteger v)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(double d)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(float f)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(BigDecimal dec)
                 throws IOException,
                        JsonGenerationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException,
                        JsonGenerationException,
                        UnsupportedOperationException

Specified by:

writeNumber in class JsonGenerator

Throws:

IOException

JsonGenerationException

UnsupportedOperationException

_verifyValueWrite

protected final void _verifyValueWrite(String typeMsg)
                                throws IOException,
                                       JsonGenerationException

Specified by:

_verifyValueWrite in class GeneratorBase

Throws:

IOException

JsonGenerationException

flush

public final void flush()
                 throws IOException

Specified by:

flush in class GeneratorBase

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Overrides:

close in class GeneratorBase

Throws:

IOException

_write7BitBinaryWithLength

protected void _write7BitBinaryWithLength(byte[] data,
                                          int offset,
                                          int len)
                                   throws IOException

Throws:

IOException

_releaseBuffers

protected void _releaseBuffers()

Specified by:

_releaseBuffers in class GeneratorBase

_flushBuffer

protected final void _flushBuffer()
                           throws IOException

Throws:

IOException

outputOffset

protected long outputOffset()

Method for accessing offset of the next byte within the whole output stream that this generator has produced.

_notSupported

protected UnsupportedOperationException _notSupported()