Jackson 3.0.1 · tools.jackson.dataformat.protobuf.ProtobufGenerator

Modifier and Type	Field and Description
protected ByteAccumulator	_buffered Object used in cases where we need to buffer content to calculate length-prefix.
protected boolean	_complete Flag that is set when the whole content is complete, can be output.
protected byte[]	_currBuffer Currently active output buffer, place where appends occur.
protected ProtobufField	_currField Field to be output next; set when `JsonToken#PROPERTY_NAME` is written, cleared once value has been written
protected ProtobufMessage	_currMessage Type of protobuf message that is currently being output: usually matches write context, but for arrays may indicate "parent" of array.
protected int	_currPtr
protected int	_currStart
protected boolean	_inObject
protected byte[]	_origCurrBuffer The first allocated (or recycled) buffer instance; needed to avoid issue [dataformat-protobuf#14].
protected final OutputStream	_output Ultimate destination
protected ProtobufWriteContext	_rootContext Reference to the root context since that is needed for serialization
protected final ProtobufSchema	_schema
protected ProtobufWriteContext	_streamWriteContext Current context, in form we can use it.
protected boolean	_writeTag Flag that indicates whether values should be written with tag or not; false for packed arrays, true for others.
protected static final ProtobufField	UNKNOWN_FIELD This instance is used as a placeholder for cases where we do not know actual field and want to simply skip over any values that caller tries to write for it.
protected static final ProtobufMessage	UNKNOWN_MESSAGE This is used as a placeholder for case where we don't have an actual message to use, but know (from context) that one is expected.
private static final Charset	UTF8

Access	Constructor and Description
public	ProtobufGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, int streamWriteFeatures, ProtobufSchema schema, OutputStream output)

Method Summary

Modifier and Type	Method and Description
protected void	_closeInput() Implements abstract tools.jackson.core.base.GeneratorBase._closeInput.
protected void	_complete()
protected void	_encodeLongerString(char[] text, int offset, int clen)
protected void	_encodeLongerString(String text)
protected final void	_ensureMore()
protected final void	_ensureRoom(int needed)
private final void	_finishBuffering() Helper method called when the current buffering scope is closed; when packed array is completed (`writeEndArray()`) or record is completed (`writeEndObject()`).
protected void	_releaseBuffers() Implements abstract tools.jackson.core.base.GeneratorBase._releaseBuffers. Method called to release any buffers generator may be holding, once generator is being closed.
protected void	_reportEnumError(Object enumValue)
private void	_reportErrorF(String format, Object... args)
protected void	_reportWrongWireType(String typeStr)
private final void	_startBuffering(int typedTag) Method called when buffering an entry that should be prefixed with a type tag.
private final void	_startBuffering() Method called when buffering an entry that should not be prefixed with a type tag.
private void	_throwIllegalSurrogate(int code)
private void	_verifyArrayWrite(Object array)
protected final void	_verifyValueWrite()
protected void	_verifyValueWrite(String typeMsg) Implements abstract tools.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	_writeEmptyString()
protected void	_writeEnum(String str)
protected void	_writeEnum(int index)
private final void	_writeInt32(int v)
private final void	_writeInt32NoTag(int v)
private final void	_writeInt64(long v64)
private final void	_writeInt64NoTag(long v64)
protected void	_writeLengthPrefixed(byte[] data, int offset, int len)
private void	_writeNonPackedArray(int[] array, int i, int end)
private void	_writeNonPackedArray(long[] array, int i, int end)
private void	_writeNonPackedArray(double[] array, int i, int end)
private void	_writePackedArray(int[] array, int i, int end)
private void	_writePackedArray(long[] array, int i, int end)
private void	_writePackedArray(double[] array, int i, int end)
private final int	_writeTag(int ptr)
private final void	_writeVInt(int v)
private final int	_writeVIntMax(int v, int ptr)
private final void	_writeVIntNoTag(int v)
private final void	_writeVLong(long v)
private final int	_writeVLongMax(long v, int ptr)
private final void	_writeVLongNoTag(long v)
public final void	assignCurrentValue(Object v) Implements abstract tools.jackson.core.JsonGenerator.assignCurrentValue. Helper method, usually equivalent to: `getOutputContext().assignCurrentValue(v);` used to assign "current value" for the current context of this generator.
public final Object	currentValue() Implements abstract tools.jackson.core.JsonGenerator.currentValue. Helper method, usually equivalent to: `getOutputContext().currentValue();` Note that "current value" is NOT populated (or used) by Streaming generator; it is only used by higher-level data-binding functionality.
public final void	flush() Implements abstract tools.jackson.core.JsonGenerator.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 PrettyPrinter	getPrettyPrinter() Overrides tools.jackson.core.JsonGenerator.getPrettyPrinter. Accessor for object that handles pretty-printing (usually additional white space to make results more human-readable) during output.
public ProtobufSchema	getSchema() Overrides tools.jackson.core.JsonGenerator.getSchema. Method for accessing Schema that this generator uses, if any.
public JacksonFeatureSet<StreamWriteCapability>	streamWriteCapabilities() Implements abstract tools.jackson.core.JsonGenerator.streamWriteCapabilities. Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).
public final TokenStreamContext	streamWriteContext() Implements abstract tools.jackson.core.JsonGenerator.streamWriteContext. Accessor for context object that provides information about low-level logical position withing output token stream.
public int	streamWriteOutputBuffered() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered. Calculating actual amount of buffering is somewhat complicated, and can not necessarily give 100% accurate answer due to presence of VInt encoding for length indicators.
public Object	streamWriteOutputTarget() Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget. Method that can be used to get access to object that is used as target for generated output; this is usually either `java.io.OutputStream` or `java.io.Writer`, depending on what generator was constructed with.
public Version	version() Implements abstract tools.jackson.core.JsonGenerator.version. Implements tools.jackson.core.Versioned.version. Accessor for finding out version of the bundle that provided this generator instance.
public JsonGenerator	writeArray(int[] array, int offset, int length) Overrides tools.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 JsonGenerator	writeArray(long[] array, int offset, int length) Overrides tools.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 JsonGenerator	writeArray(double[] array, int offset, int length) Overrides tools.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 JsonGenerator	writeBinary(Base64Variant b64variant, byte[] data, int offset, int len) Implements abstract tools.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 JsonGenerator	writeBoolean(boolean state) Implements abstract tools.jackson.core.JsonGenerator.writeBoolean. Method for outputting literal JSON boolean value (one of Strings 'true' and 'false').
public JsonGenerator	writeEndArray() Implements abstract tools.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 JsonGenerator	writeEndObject() Implements abstract tools.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 JsonGenerator	writeName(String name) Implements abstract tools.jackson.core.JsonGenerator.writeName. Method for writing an Object Property 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 JsonGenerator	writeName(SerializableString sstr) Overrides tools.jackson.core.base.GeneratorBase.writeName. Method similar to `writeName(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 JsonGenerator	writeNull() Implements abstract tools.jackson.core.JsonGenerator.writeNull. Method for outputting literal JSON null value.
public JsonGenerator	writeNumber(short v) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public JsonGenerator	writeNumber(int v) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public JsonGenerator	writeNumber(long v) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public JsonGenerator	writeNumber(BigInteger v) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting given value as JSON number.
public JsonGenerator	writeNumber(double d) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public JsonGenerator	writeNumber(float f) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public JsonGenerator	writeNumber(BigDecimal v) Implements abstract tools.jackson.core.JsonGenerator.writeNumber. Method for outputting indicate JSON numeric value.
public JsonGenerator	writeNumber(String encodedValue) Implements abstract tools.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 JsonGenerator	writePropertyId(long id) Implements abstract tools.jackson.core.JsonGenerator.writePropertyId. Alternative to `writeName(String)` that may be used in cases where Object Property key is of numeric type; usually where underlying format supports such notion (some binary formats do, unlike JSON).
public JsonGenerator	writeRaw(String text) Implements abstract tools.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 JsonGenerator	writeRaw(String text, int offset, int len) Implements abstract tools.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 JsonGenerator	writeRaw(char[] text, int offset, int len) Implements abstract tools.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 JsonGenerator	writeRaw(char c) Implements abstract tools.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 JsonGenerator	writeRawUTF8String(byte[] text, int offset, int len) Implements abstract tools.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 JsonGenerator	writeRawValue(String text) Overrides tools.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 JsonGenerator	writeRawValue(String text, int offset, int len) Overrides tools.jackson.core.base.GeneratorBase.writeRawValue.
public JsonGenerator	writeRawValue(char[] text, int offset, int len) Overrides tools.jackson.core.base.GeneratorBase.writeRawValue.
public JsonGenerator	writeStartArray() Implements abstract tools.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 JsonGenerator	writeStartArray(Object currValue) Implements abstract tools.jackson.core.JsonGenerator.writeStartArray. Method for writing start marker of an Array value, similar to `writeStartArray()`, but also specifying what is the Java object that the Array Object being written represents (if any); `null` may be passed if not known or not applicable.
public JsonGenerator	writeStartObject(Object currValue) Implements abstract tools.jackson.core.JsonGenerator.writeStartObject. Method for writing starting marker of an Object value to represent the given Java Object value.
public JsonGenerator	writeStartObject() Implements abstract tools.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 JsonGenerator	writeString(String text) Implements abstract tools.jackson.core.JsonGenerator.writeString. Method for outputting a String value.
public JsonGenerator	writeString(char[] text, int offset, int clen) Implements abstract tools.jackson.core.JsonGenerator.writeString. Method for outputting a String value.
public JsonGenerator	writeString(SerializableString sstr) Overrides tools.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 JsonGenerator	writeUTF8String(byte[] text, int offset, int len) Implements abstract tools.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 ProtobufGenerator

Field Summary

Constructor Summary

Method Summary