Jackson dataformat: Smile 2.16.0 · com.fasterxml.jackson.dataformat.smile.SmileGenerator

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

Modifier and Type	Field and Description
protected boolean	_bufferRecyclable Flag that indicates whether the output buffer is recyclable (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 int	_formatFeatures Bit flag composed of bits that indicate which `com.fasterxml.jackson.dataformat.smile.SmileGenerator.Feature`s are enabled.
protected final OutputStream	_out
protected byte[]	_outputBuffer Intermediate buffer in which contents are buffered before being written using `_out`.
protected final 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 final StreamWriteConstraints	_streamWriteConstraints
protected SmileWriteContext	_streamWriteContext
protected static final int	DEFAULT_NAME_BUFFER_LENGTH
protected static final int	DEFAULT_STRING_VALUE_BUFFER_LENGTH
protected static final long	MAX_INT_AS_LONG
private static final int	MIN_BUFFER_LENGTH To simplify certain operations, we require output buffer length to allow outputting of contiguous 256 character UTF-8 encoded String value.
protected static final long	MIN_INT_AS_LONG
protected static final int	REPLACEMENT_CHAR The replacement character to use to fix invalid Unicode sequences (mismatched surrogate pair).
protected static final byte	TOKEN_BYTE_BIG_DECIMAL
protected static final byte	TOKEN_BYTE_BIG_INTEGER
protected static final byte	TOKEN_BYTE_FLOAT_32
protected static final byte	TOKEN_BYTE_FLOAT_64
protected static final byte	TOKEN_BYTE_INT_32
protected static final byte	TOKEN_BYTE_INT_64
protected static final byte	TOKEN_BYTE_LONG_STRING_ASCII

Access	Constructor and Description
public	SmileGenerator(IOContext ioCtxt, int stdFeatures, int smileFeatures, ObjectCodec codec, OutputStream out)
public	SmileGenerator(IOContext ioCtxt, int stdFeatures, int smileFeatures, ObjectCodec codec, OutputStream out, byte[] outputBuffer, int offset, boolean bufferRecyclable)

Method Summary

Modifier and Type	Method and Description
private final void	_addSeenName(String name)
private final void	_addSeenStringValue(String text)
private int	_appendReplacementChar(byte[] outBuf, int outputPtr)
private int	_decodeAndWriteSurrogate(int surr1, int surr2, byte[] outBuf, int outputPtr)
private final void	_ensureRoomForOutput(int needed)
private final int	_findSeenName(String name)
private final int	_findSeenStringValue(String text)
protected final void	_flushBuffer()
private int	_invalidSurrogateEnd(int surr1, int surr2, byte[] outBuf, int outputPtr)
private int	_invalidSurrogateStart(int code, byte[] outBuf, int outputPtr)
private void	_mediumUTF8Encode(char[] str, int inputPtr, int inputEnd)
private void	_mediumUTF8Encode(String str, int inputPtr, int inputEnd)
protected UnsupportedOperationException	_notSupported()
private int	_readMore(InputStream in, byte[] readBuffer, int inputPtr, int inputEnd, int maxRead)
protected void	_releaseBuffers() Implements abstract com.fasterxml.jackson.core.base.GeneratorBase._releaseBuffers. Method called to release any buffers generator may be holding, once generator is being closed.
private final int	_shortUTF8Encode(char[] str, int i, int end) Helper method called when the whole character sequence is known to fit in the output buffer regardless of UTF-8 expansion.
private final int	_shortUTF8Encode(String str, int i, int end)
private final int	_shortUTF8Encode2(char[] str, int i, int end, int outputPtr) Helper method called when the whole character sequence is known to fit in the output buffer, but not all characters are single-byte (ASCII) characters.
private final int	_shortUTF8Encode2(String str, int i, int end, int outputPtr)
private static final boolean	_validBackRef(int index) Helper method used to ensure that we do not use back-reference values that would produce illegal byte sequences (ones with byte 0xFE or 0xFF).
protected final void	_verifyValueWrite(String Additional message used for generating exception message if value output is NOT legal in current generator output state. typeMsg) Implements abstract com.fasterxml.jackson.core.base.GeneratorBase._verifyValueWrite. Method called before trying to write a value (scalar or structured), to verify that this is legal in current output state, as well as to output separators if and as necessary.
protected void	_write7BitBinaryWithLength(byte[] data, int offset, int len)
protected int	_write7BitBinaryWithLength(InputStream in, int bytesLeft, byte[] buffer)
private final void	_writeByte(byte b)
private final void	_writeBytes(byte b1, byte b2)
private final void	_writeBytes(byte b1, byte b2, byte b3)
private final void	_writeBytes(byte b1, byte b2, byte b3, byte b4)
private final void	_writeBytes(byte b1, byte b2, byte b3, byte b4, byte b5)
private final void	_writeBytes(byte b1, byte b2, byte b3, byte b4, byte b5, byte b6)
private final void	_writeBytes(byte[] data, int offset, int len)
private final int	_writeBytes(InputStream in, int bytesLeft)
private final void	_writeBytesLong(byte[] data, int offset, int len)
protected void	_writeDecimalNumber(String enc)
private final void	_writeFieldName(String name)
protected final void	_writeFieldName(SerializableString name)
protected final void	_writeFieldNameUnicode(SerializableString name, byte[] bytes)
protected void	_writeIntegralNumber(String enc, boolean neg)
private final void	_writeLongAsciiFieldName(byte[] bytes)
private final void	_writeNonSharedString(final String text, final int len) Helper method called to handle cases where String value to write is known to be long enough not to be shareable.
private final void	_writeNonShortFieldName(final String name, final int len)
private final int	_writeNumberNoChecks(int ptr, int i)
private final int	_writeNumberNoChecks(int ptr, long l)
private final int	_writeNumberNoChecks(int ptr, double d)
private void	_writePositiveVInt(int i) Helper method for writing a 32-bit positive (really 31-bit then) value.
private final void	_writeSharedNameReference(int ix)
private final void	_writeSharedStringValueReference(int ix)
private void	_writeSignedVInt(int input) Helper method for writing 32-bit signed value, using "zig zag encoding" (see protocol buffers for explanation -- basically, sign bit is moved as LSB, rest of value shifted left by one) coupled with basic variable length encoding
public void	assignCurrentValue(Object Current value to assign for the current context of this generator v) Overrides com.fasterxml.jackson.core.JsonGenerator.assignCurrentValue. Helper method, usually equivalent to: `getOutputContext().setCurrentValue(v);`
public boolean	canWriteBinaryNatively() Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteBinaryNatively. Introspection method that may be called to see if the underlying data format supports "native" binary data; that is, an efficient output of binary content without encoding.
public void	close() Overrides com.fasterxml.jackson.core.base.GeneratorBase.close. Implements java.io.Closeable.close. Method called to close this generator, so that no more content can be written.
public SmileGenerator	configure(SmileGenerator.Feature f, boolean state)
public Object	currentValue() Overrides com.fasterxml.jackson.core.JsonGenerator.currentValue. Helper method, usually equivalent to: `getOutputContext().getCurrentValue();` Note that "current value" is NOT populated (or used) by Streaming parser or generators; it is only used by higher-level data-binding functionality.
public SmileGenerator	disable(SmileGenerator.Feature f)
public SmileGenerator	enable(SmileGenerator.Feature f)
public final void	flush() Implements abstract com.fasterxml.jackson.core.base.GeneratorBase.flush. Implements java.io.Flushable.flush. Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.
public Object	getCurrentValue() Overrides com.fasterxml.jackson.core.base.GeneratorBase.getCurrentValue. Alias for `currentValue()`, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
public int	getFormatFeatures() Overrides com.fasterxml.jackson.core.JsonGenerator.getFormatFeatures. Bulk access method for getting state of all `FormatFeature`s, format-specific on/off configuration settings.
public int	getOutputBuffered() Overrides com.fasterxml.jackson.core.JsonGenerator.getOutputBuffered. Method for verifying amount of content that is buffered by generator but not yet flushed to the underlying target (stream, writer), in units (byte, char) that the generator implementation uses for buffering; or -1 if this information is not available.
public JsonStreamContext	getOutputContext() Overrides com.fasterxml.jackson.core.base.GeneratorBase.getOutputContext. Note type was co-variant until Jackson 2.7; reverted back to base type in 2.8 to allow for overriding by subtypes that use custom context type.
public Object	getOutputTarget() Overrides com.fasterxml.jackson.core.JsonGenerator.getOutputTarget. Method that can be used to get access to object that is used as target for generated output; this is usually either `OutputStream` or `Writer`, depending on what generator was constructed with.
public JacksonFeatureSet<StreamWriteCapability>	getWriteCapabilities() Overrides com.fasterxml.jackson.core.JsonGenerator.getWriteCapabilities. Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).
public final 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.
public JsonGenerator	overrideFormatFeatures(int Bit mask of set/clear state for features to change values, int Bit mask of features to change mask) Overrides com.fasterxml.jackson.core.JsonGenerator.overrideFormatFeatures. Bulk set method for (re)setting states of `FormatFeature`s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.
public void	setCurrentValue(Object Current value to assign for the current context of this generator v) Overrides com.fasterxml.jackson.core.base.GeneratorBase.setCurrentValue. Alias for `assignCurrentValue`, to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
public JsonGenerator	setPrettyPrinter(PrettyPrinter `PrettyPrinter` to assign, if any; `null` if none pp) Overrides com.fasterxml.jackson.core.JsonGenerator.setPrettyPrinter. No way (or need) to indent anything, so let's block any attempts.
public StreamWriteConstraints	streamWriteConstraints() Overrides com.fasterxml.jackson.core.JsonGenerator.streamWriteConstraints. Get the constraints to apply when performing streaming writes.
public JsonGenerator	useDefaultPrettyPrinter() Overrides com.fasterxml.jackson.core.base.GeneratorBase.useDefaultPrettyPrinter. No way (or need) to indent anything, so let's block any attempts.
public Version	version() Overrides com.fasterxml.jackson.core.base.GeneratorBase.version. Implements com.fasterxml.jackson.core.Versioned.version. Implemented with standard version number detection algorithm, typically using a simple generated class, with information extracted from Maven project file during build.
public void	writeArray(int[] Array that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length) Overrides com.fasterxml.jackson.core.JsonGenerator.writeArray. Value write method that can be called to write a single array (sequence of `JsonToken#START_ARRAY`, zero or more `JsonToken#VALUE_NUMBER_INT`, `JsonToken#END_ARRAY`)
public void	writeArray(long[] Array that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length) Overrides com.fasterxml.jackson.core.JsonGenerator.writeArray. Value write method that can be called to write a single array (sequence of `JsonToken#START_ARRAY`, zero or more `JsonToken#VALUE_NUMBER_INT`, `JsonToken#END_ARRAY`)
public void	writeArray(double[] Array that contains values to write array, int Offset of the first element to write, within array offset, int Number of elements in array to write, from `offset` to `offset + len - 1` length) Overrides com.fasterxml.jackson.core.JsonGenerator.writeArray. Value write method that can be called to write a single array (sequence of `JsonToken#START_ARRAY`, zero or more `JsonToken#VALUE_NUMBER_FLOAT`, `JsonToken#END_ARRAY`)
public void	writeBinary(Base64Variant Base64 variant to use: defines details such as whether padding is used (and if so, using which character); what is the maximum line length before adding linefeed, and also the underlying alphabet to use. b64variant, byte[] Buffer that contains binary data to write data, int Offset in `data` of the first byte of data to write offset, int Length of data to write len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeBinary. Method that will output given chunk of binary data as base64 encoded, as a complete String value (surrounded by double quotes).
public int	writeBinary(InputStream InputStream to use for reading binary data to write. Will not be closed after successful write operation data, int (optional) number of bytes that will be available; or -1 to be indicate it is not known. Note that implementations need not support cases where length is not known in advance; this depends on underlying data format: JSON output does NOT require length, other formats may dataLength) Overrides com.fasterxml.jackson.core.JsonGenerator.writeBinary. Similar to `writeBinary(Base64Variant, InputStream, int)`, but assumes default to using the Jackson default Base64 variant (which is `Base64Variants#MIME_NO_LINEFEEDS`).
public int	writeBinary(Base64Variant Base64 variant to use b64variant, InputStream InputStream to use for reading binary data to write. Will not be closed after successful write operation data, int (optional) number of bytes that will be available; or -1 to be indicate it is not known. If a positive length is given, `data` MUST provide at least that many bytes: if not, an exception will be thrown. Note that implementations need not support cases where length is not known in advance; this depends on underlying data format: JSON output does NOT require length, other formats may. dataLength) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeBinary. Method similar to `writeBinary(Base64Variant, byte[], int, int)`, but where input is provided through a stream, allowing for incremental writes without holding the whole input in memory.
public void	writeBoolean(boolean Boolean value to write state) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeBoolean. Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').
public void	writeBytes(byte[] data, int offset, int len) Method for directly inserting specified bytes in output at current position.
public final void	writeEndArray() Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeEndArray. Method for writing closing marker of a JSON Array value (character ']'; plus possible white space decoration if pretty-printing is enabled).
public final void	writeEndObject() Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeEndObject. Method for writing closing marker of an Object value (character '}'; plus possible white space decoration if pretty-printing is enabled).
public final void	writeFieldName(String Field name to write name) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeFieldName. Method for writing a field name (JSON String surrounded by double quotes: syntactically identical to a JSON String value), possibly decorated by white space if pretty-printing is enabled.
public final void	writeFieldName(SerializableString Field name to write name) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeFieldName. Method similar to `writeFieldName(String)`, main difference being that it may perform better as some of processing (such as quoting of certain characters, or encoding into external encoding if supported by generator) can be done just once and reused for later calls.
public void	writeHeader() Method that can be called to explicitly write Smile document header.
public void	writeNull() Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNull. Method for outputting literal JSON null value.
public void	writeNumber(int Number value to write i) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public void	writeNumber(long Number value to write l) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public void	writeNumber(BigInteger Number value to write v) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public void	writeNumber(double Number value to write d) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public void	writeNumber(float Number value to write f) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public void	writeNumber(BigDecimal Number value to write dec) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public void	writeNumber(String Textual (possibly format) number representation to write encodedValue) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeNumber. Write method that can be used for custom numeric types that can not be (easily?) converted to "standard" Java number types.
public void	writeRaw(byte b) Method for directly inserting specified byte in output at current position.
public void	writeRaw(String Textual contents to include as-is in output. text) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw. Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
public void	writeRaw(String String that has contents to include as-is in output text, int Offset within `text` of the first character to output offset, int Length of content (from `text`, starting at offset `offset`) to output len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw. Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
public void	writeRaw(char[] Buffer that has contents to include as-is in output text, int Offset within `text` of the first character to output offset, int Length of content (from `text`, starting at offset `offset`) to output len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw. Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
public void	writeRaw(char Character to included in output c) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRaw. Method that will force generator to copy input text verbatim with no modifications (including that no escaping is done and no separators are added even if context [array, object] would otherwise require such).
public void	writeRawUTF8String(byte[] Buffer that contains String value to write text, int Offset in `buffer` of the first byte of String value to write offset, int Length of the String value (in characters) to write len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeRawUTF8String. Method similar to `writeString(String)` but that takes as its input a UTF-8 encoded String that is to be output as-is, without additional escaping (type of which depends on data format; backslashes for JSON).
public void	writeRawValue(String Textual contents to included in output text) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeRawValue. Method that will force generator to copy input text verbatim without any modifications, but assuming it must constitute a single legal JSON value (number, string, boolean, null, Array or List).
public void	writeRawValue(String text, int offset, int len) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeRawValue.
public void	writeRawValue(char[] text, int offset, int len) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeRawValue.
public final void	writeStartArray() Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeStartArray. Method for writing starting marker of a Array value (for JSON this is character '['; plus possible white space decoration if pretty-printing is enabled).
public final void	writeStartArray(Object "Current value" to assign for the Array context being created forValue) Overrides com.fasterxml.jackson.core.JsonGenerator.writeStartArray. Method for writing start marker of an Array value, similar to `writeStartArray()`, but also specifying the "current value" to assign to the new Array context being created.
public final void	writeStartArray(Object "Current value" to assign for the Array context being created forValue, int Number of elements this Array will have: actual number of values written (before matching call to `writeEndArray()` MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length) elementsToWrite) Overrides com.fasterxml.jackson.core.JsonGenerator.writeStartArray. Method for writing start marker of an Array value, similar to `writeStartArray()`, but also specifying the "current value" to assign to the new Array context being created as well as how many elements will be written for the array before calling `writeEndArray()`.
public final void	writeStartArray(int Number of elements this array will have: actual number of values written (before matching call to `writeEndArray()` MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length) size) Overrides com.fasterxml.jackson.core.JsonGenerator.writeStartArray. Deprecated Method for writing start marker of an Array value, similar to `writeStartArray()`, but also specifying how many elements will be written for the array before calling `writeEndArray()`.
public final void	writeStartObject() Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeStartObject. Method for writing starting marker of an Object value (character '{'; plus possible white space decoration if pretty-printing is enabled).
public final void	writeStartObject(Object "Current value" to assign for the Object context being created forValue) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeStartObject. Method for writing starting marker of an Object value to represent the given Java Object value.
public void	writeStartObject(Object "Current value" to assign for the Object context being created forValue, int Number of key/value pairs this Object will have: actual number of entries written (before matching call to `writeEndObject()` MUST match; generator MAY verify this is the case (and SHOULD if format itself encodes length) elementsToWrite) Overrides com.fasterxml.jackson.core.JsonGenerator.writeStartObject. Method for writing starting marker of an Object value to represent the given Java Object value.
public void	writeString(String Text value to write text) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeString. Method for outputting a String value.
public void	writeString(char[] Buffer that contains String value to write text, int Offset in `buffer` of the first character of String value to write offset, int Length of the String value (in characters) to write len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeString. Method for outputting a String value.
public final void	writeString(SerializableString Pre-encoded String value to write sstr) Overrides com.fasterxml.jackson.core.base.GeneratorBase.writeString. Method similar to `writeString(String)`, but that takes `SerializableString` which can make this potentially more efficient to call as generator may be able to reuse quoted and/or encoded representation.
public final void	writeUTF8String(byte[] Buffer that contains String value to write text, int Offset in `buffer` of the first byte of String value to write offset, int Length of the String value (in characters) to write len) Implements abstract com.fasterxml.jackson.core.JsonGenerator.writeUTF8String. Method similar to `writeString(String)` but that takes as its input a UTF-8 encoded String which has not been escaped using whatever escaping scheme data format requires (for JSON that is backslash-escaping for control characters and double-quotes; for other formats something else).

public Class SmileGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary