Jackson 2.18.2 · com.fasterxml.jackson.dataformat.yaml.YAMLGenerator

Modifier and Type	Class and Description
public static enum	YAMLGenerator.Feature Enumeration that defines all togglable features for YAML generators

Modifier and Type	Field and Description
protected final DumperOptions.Version	_docVersion
protected Emitter	_emitter
protected int	_formatFeatures Bit flag composed of bits that indicate which `YAMLGenerator.Feature`s are enabled.
protected String	_objectId YAML supports native Object identifiers, so databinder may indicate need to output one.
protected DumperOptions	_outputOptions
protected final StringQuotingChecker	_quotingChecker
protected int	_rootValueCount
protected final StreamWriteConstraints	_streamWriteConstraints
protected String	_typeId YAML supports native Type identifiers, so databinder may indicate need to output one.
protected Writer	_writer
private static final ImplicitTuple	EXPLICIT_TAGS
protected static final long	MAX_INT_AS_LONG
protected static final long	MIN_INT_AS_LONG
private static final ImplicitTuple	NO_TAGS
protected static final Pattern	PLAIN_NUMBER_P
private static final DumperOptions.ScalarStyle	STYLE_BASE64
private static final DumperOptions.ScalarStyle	STYLE_LITERAL
private static final DumperOptions.ScalarStyle	STYLE_PLAIN
private static final DumperOptions.ScalarStyle	STYLE_QUOTED
private static final DumperOptions.ScalarStyle	STYLE_SCALAR
private static final DumperOptions.ScalarStyle	STYLE_UNQUOTED_NAME
protected static final String	TAG_BINARY

Access	Constructor and Description
public	YAMLGenerator(IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, ObjectCodec codec, Writer out, DumperOptions.Version version)
public	YAMLGenerator(IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, ObjectCodec codec, Writer out, DumperOptions dumperOptions)
public	YAMLGenerator(IOContext ctxt, int jsonFeatures, int yamlFeatures, ObjectCodec codec, Writer out, DumperOptions.Version version) Deprecated

Method Summary

Modifier and Type	Method and Description
private String	_base64encode(final Base64Variant b64v, final byte[] input, final String linefeed)
protected final void	_emit(Event e)
protected void	_emitEndDocument()
protected void	_emitStartDocument()
protected String	_lf()
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.
protected ScalarEvent	_scalarEvent(String value, DumperOptions.ScalarStyle style)
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.
private final void	_writeFieldName(String name)
protected void	_writeScalar(String value, String type, DumperOptions.ScalarStyle style)
private void	_writeScalarBinary(Base64Variant b64variant, byte[] data)
protected DumperOptions	buildDumperOptions(int jsonFeatures, int yamlFeatures, DumperOptions.Version version)
public boolean	canUseSchema(FormatSchema Schema to check schema) Overrides com.fasterxml.jackson.core.JsonGenerator.canUseSchema. Method that can be used to verify that given schema can be used with this generator (using `setSchema`).
public boolean	canWriteFormattedNumbers() Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteFormattedNumbers. Introspection method to call to check whether it is possible to write numbers using `writeNumber(java.lang.String)` using possible custom format, or not.
public boolean	canWriteObjectId() Overrides com.fasterxml.jackson.core.JsonGenerator.canWriteObjectId. Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).
public boolean	canWriteTypeId() Overrides com.fasterxml.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).
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 YAMLGenerator	configure(YAMLGenerator.Feature f, boolean state)
public YAMLGenerator	disable(YAMLGenerator.Feature f)
public YAMLGenerator	enable(YAMLGenerator.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 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. SnakeYAML does not expose buffered content amount, so we can only return `-1` from here
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(YAMLGenerator.Feature f)
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 YAMLGenerator	setPrettyPrinter(PrettyPrinter `PrettyPrinter` to assign, if any; `null` if none pp) Overrides com.fasterxml.jackson.core.JsonGenerator.setPrettyPrinter. Not sure what to do here; will always indent, but uses YAML-specific settings etc.
public StreamWriteConstraints	streamWriteConstraints() Overrides com.fasterxml.jackson.core.JsonGenerator.streamWriteConstraints. Get the constraints to apply when performing streaming writes.
public YAMLGenerator	useDefaultPrettyPrinter() Overrides com.fasterxml.jackson.core.base.GeneratorBase.useDefaultPrettyPrinter. Not sure what to do here; could reset indentation to some value maybe?
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	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 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 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 void	writeFieldId(long Field id to write id) Overrides com.fasterxml.jackson.core.JsonGenerator.writeFieldId. Alternative to `writeFieldName(String)` that may be used in cases where property key is of numeric type; either where underlying format supports such notion (some binary formats do, unlike JSON), or for convenient conversion into String presentation.
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	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 formatted) 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	writeObjectId(Object Native Object Id to write id) Overrides com.fasterxml.jackson.core.JsonGenerator.writeObjectId. Method that can be called to output so-called native Object Id. Note that it may only be called after ensuring this is legal (with `canWriteObjectId()`), as not all data formats have native type id support; and some may only allow them in certain positions or locations.
public void	writeObjectRef(Object Referenced value, for which Object Id is expected to be written id) Overrides com.fasterxml.jackson.core.JsonGenerator.writeObjectRef. Method that can be called to output references to native Object Ids.
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	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 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 void	writeTypeId(Object Native Type Id to write id) Overrides com.fasterxml.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.
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 YAMLGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary