public Class IonGenerator

Annotates the next structure or value written -- stepIn() or one of the IonWriters write*() methods.

Parameters

annotation:String

a type annotation

See Also

tools.jackson.dataformat.ion.polymorphism.IonAnnotationTypeSerializer

Implements abstract tools.jackson.core.JsonGenerator.assignCurrentValue.

Doc from 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. It is usually assigned and used by higher level data-binding functionality (instead of streaming parsers/generators) but is stored at streaming level.

Annotations

@Override

Overrides tools.jackson.core.JsonGenerator.canWriteTypeId.

Doc from tools.jackson.core.JsonGenerator.canWriteTypeId.

Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). This method must be called prior to calling writeTypeId.

Default implementation returns false; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native type ids.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.currentValue.

Doc from 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. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.flush.

Implements java.io.Flushable.flush.

Doc from tools.jackson.core.JsonGenerator.flush.

Method called to flush any buffered content to the underlying target (output stream, writer), and to flush the target itself as well.

Annotations

@Override

Overrides tools.jackson.core.JsonGenerator.getPrettyPrinter.

Doc from tools.jackson.core.JsonGenerator.getPrettyPrinter.

Accessor for object that handles pretty-printing (usually additional white space to make results more human-readable) during output. If null, no pretty-printing is done.

Default implementation returns null so pretty-printing capable generators need to override it.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.streamWriteCapabilities.

Doc from tools.jackson.core.JsonGenerator.streamWriteCapabilities.

Accessor for getting metadata on capabilities of this generator, based on underlying data format being read (directly or indirectly).

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.streamWriteContext.

Doc from tools.jackson.core.JsonGenerator.streamWriteContext.

Accessor for context object that provides information about low-level logical position withing output token stream.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputBuffered.

Doc from tools.jackson.core.JsonGenerator.streamWriteOutputBuffered.

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. Unit used is often the same as the unit of underlying target (that is, byte for java.io.OutputStream, char for java.io.Writer), but may differ if buffering is done before encoding. Default JSON-backed implementations do use matching units.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.streamWriteOutputTarget.

Doc from 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. Note that returned value may be null in some cases; including case where implementation does not want to exposed raw source to caller. In cases where output has been decorated, object returned here is the decorated version; this allows some level of interaction between users of generator and decorator object.

In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.core.JsonGenerator.version.

Accessor for finding out version of the bundle that provided this generator instance.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeBinary.

Doc from 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). This method defaults

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeBoolean.

Doc from tools.jackson.core.JsonGenerator.writeBoolean.

Method for outputting literal JSON boolean value (one of Strings 'true' and 'false'). Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeEndArray.

Doc from 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).

Marker can be written if the innermost structured type is Array.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeEndObject.

Doc from 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).

Marker can be written if the innermost structured type is Object, and the last written event was either a complete value, or START-OBJECT marker (see JSON specification for more details).

Annotations

@Override

Since

2.12.2

Implements abstract tools.jackson.core.JsonGenerator.writeName.

Doc from 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.

Property names can only be written in Object context (check out JSON specification for details), when Object Property name is expected (property names alternate with values).

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNull.

Doc from tools.jackson.core.JsonGenerator.writeNull.

Method for outputting literal JSON null value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting given value as JSON number. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from tools.jackson.core.JsonGenerator.writeNumber.

Method for outputting indicate JSON numeric value. Can be called in any context where a value is expected (Array value, Object property value, root-level value). Additional white space may be added around the value if pretty-printing is enabled.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeNumber.

Doc from 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. Because numbers are not surrounded by double quotes, regular writeString method cannot be used; nor writeRaw because that does not properly handle value separators needed in Array or Object contexts.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writePropertyId.

Doc from 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). Default implementation will simply convert id into String and call writeName(String).

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRaw.

Doc from 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). If such separators are desired, use writeRawValue(String) instead.

Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRaw.

Doc from 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). If such separators are desired, use writeRawValue(String) instead.

Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRaw.

Doc from 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). If such separators are desired, use writeRawValue(String) instead.

Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRaw.

Doc from 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). If such separators are desired, use writeRawValue(String) instead.

Note that not all generator implementations necessarily support such by-pass methods: those that do not will throw UnsupportedOperationException.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeRawUTF8String.

Doc from 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). However, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.

Note that some backends may choose not to support this method: for example, if underlying destination is a java.io.Writer using this method would require UTF-8 decoding. If so, implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.

Annotations

@Override

Overrides tools.jackson.core.base.GeneratorBase.writeRawValue.

Doc from tools.jackson.core.JsonGenerator.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). Assuming this, proper separators are added if and as needed (comma or colon), and generator state updated to reflect this.

Annotations

@Override

Overrides tools.jackson.core.base.GeneratorBase.writeRawValue.

Annotations

@Override

Overrides tools.jackson.core.base.GeneratorBase.writeRawValue.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartArray.

Doc from 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).

Array values can be written in any context where values are allowed: meaning everywhere except for when a property name is expected.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartArray.

Doc from 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. This value is accessible from context as "current value"

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartObject.

Doc from 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).

Object values can be written in any context where values are allowed: meaning everywhere except for when a property name is expected.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeStartObject.

Doc from tools.jackson.core.JsonGenerator.writeStartObject.

Method for writing starting marker of an Object value to represent the given Java Object value. Argument is offered as metadata, but more importantly it should be assigned as the "current value" for the Object content that gets constructed and initialized.

Object values can be written in any context where values are allowed: meaning everywhere except for when a property name is expected.

Annotations

@Override

Since

2.12.2

Implements abstract tools.jackson.core.JsonGenerator.writeString.

Doc from tools.jackson.core.JsonGenerator.writeString.

Method for outputting a String value. Depending on context this means either array element, (object) property value or a stand-alone (root-level value) String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeString.

Doc from tools.jackson.core.JsonGenerator.writeString.

Method for outputting a String value. Depending on context this means either array element, (object) property value or a stand alone String; but in all cases, String will be surrounded in double quotes, and contents will be properly escaped as required by JSON specification.

Annotations

@Override

Overrides tools.jackson.core.JsonGenerator.writeTypeId.

Doc from tools.jackson.core.JsonGenerator.writeTypeId.

Method that can be called to output so-called native Type Id. Note that it may only be called after ensuring this is legal (with canWriteTypeId()), as not all data formats have native type id support; and some may only allow them in certain positions or locations. If output is not allowed by the data format in this position, a StreamWriteException will be thrown.

Annotations

@Override

Implements abstract tools.jackson.core.JsonGenerator.writeUTF8String.

Doc from 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). This means that textual JSON backends need to check if value needs JSON escaping, but otherwise can just be copied as is to output. Also, quoting that data format requires (like double-quotes for JSON) will be added around the value if and as necessary.

Note that some backends may choose not to support this method: for example, if underlying destination is a java.io.Writer using this method would require UTF-8 decoding. In this case generator implementation may instead choose to throw a UnsupportedOperationException due to ineffectiveness of having to decode input.

Annotations

@Override