Class YAMLGenerator
java.lang.Object
com.fasterxml.jackson.core.JsonGenerator
com.fasterxml.jackson.core.base.GeneratorBase
com.fasterxml.jackson.dataformat.yaml.YAMLGenerator
- All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned
,Closeable
,Flushable
,AutoCloseable
public class YAMLGenerator
extends com.fasterxml.jackson.core.base.GeneratorBase
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Enumeration that defines all togglable features for YAML generators -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.yaml.snakeyaml.DumperOptions.Version
protected org.yaml.snakeyaml.emitter.Emitter
protected int
Bit flag composed of bits that indicate whichYAMLGenerator.Feature
s are enabled.protected final com.fasterxml.jackson.core.io.IOContext
protected String
YAML supports native Object identifiers, so databinder may indicate need to output one.protected org.yaml.snakeyaml.DumperOptions
protected final StringQuotingChecker
protected int
protected String
YAML supports native Type identifiers, so databinder may indicate need to output one.protected Writer
private static final org.yaml.snakeyaml.events.ImplicitTuple
protected static final long
protected static final long
private static final org.yaml.snakeyaml.events.ImplicitTuple
protected static final Pattern
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle
protected static final String
Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext, DERIVED_FEATURES_MASK, MAX_BIG_DECIMAL_SCALE, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST, WRITE_BINARY, WRITE_BOOLEAN, WRITE_NULL, WRITE_NUMBER, WRITE_RAW, WRITE_STRING
Fields inherited from class com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES
-
Constructor Summary
ConstructorsConstructorDescriptionYAMLGenerator
(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions.Version version) Deprecated.YAMLGenerator
(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions dumperOptions) YAMLGenerator
(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions.Version version) -
Method Summary
Modifier and TypeMethodDescriptionprivate String
_base64encode
(com.fasterxml.jackson.core.Base64Variant b64v, byte[] input, String linefeed) protected final void
_emit
(org.yaml.snakeyaml.events.Event e) protected void
protected void
protected String
_lf()
protected void
protected org.yaml.snakeyaml.events.ScalarEvent
_scalarEvent
(String value, org.yaml.snakeyaml.DumperOptions.ScalarStyle style) protected final void
_verifyValueWrite
(String typeMsg) private final void
_writeFieldName
(String name) protected void
_writeScalar
(String value, String type, org.yaml.snakeyaml.DumperOptions.ScalarStyle style) private void
_writeScalarBinary
(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data) protected org.yaml.snakeyaml.DumperOptions
buildDumperOptions
(int jsonFeatures, int yamlFeatures, org.yaml.snakeyaml.DumperOptions.Version version) boolean
canUseSchema
(com.fasterxml.jackson.core.FormatSchema schema) boolean
boolean
boolean
void
close()
configure
(YAMLGenerator.Feature f, boolean state) final void
flush()
int
int
SnakeYAML does not expose buffered content amount, so we can only return-1
from herecom.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability>
final boolean
com.fasterxml.jackson.core.JsonGenerator
overrideFormatFeatures
(int values, int mask) setPrettyPrinter
(com.fasterxml.jackson.core.PrettyPrinter pp) Not sure what to do here; will always indent, but uses YAML-specific settings etc.Not sure what to do here; could reset indentation to some value maybe?com.fasterxml.jackson.core.Version
version()
void
writeBinary
(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data, int offset, int len) void
writeBoolean
(boolean state) final void
final void
void
writeFieldId
(long id) final void
writeFieldName
(com.fasterxml.jackson.core.SerializableString name) final void
writeFieldName
(String name) void
void
writeNumber
(double d) void
writeNumber
(float f) void
writeNumber
(int i) void
writeNumber
(long l) void
writeNumber
(String encodedValue) void
writeNumber
(BigDecimal dec) void
void
writeObjectId
(Object id) void
writeObjectRef
(Object id) void
writeRaw
(char c) void
writeRaw
(char[] text, int offset, int len) void
void
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) final void
final void
void
writeString
(char[] text, int offset, int len) final void
writeString
(com.fasterxml.jackson.core.SerializableString sstr) void
writeString
(String text) void
writeTypeId
(Object id) final void
writeUTF8String
(byte[] text, int offset, int len) Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_asString, _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _checkRangeBoundsForString, _checkStdFeatureChanges, _constructDefaultPrettyPrinter, _decodeSurrogate, disable, enable, getCodec, getCurrentValue, getFeatureMask, getOutputContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setCurrentValue, setFeatureMask, writeBinary, writeObject, writeRawValue, writeStartObject, writeTree
Methods inherited from class com.fasterxml.jackson.core.JsonGenerator
_copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportError, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, assignCurrentValue, canOmitFields, canWriteBinaryNatively, configure, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, currentValue, getCharacterEscapes, getHighestEscapedChar, getPrettyPrinter, getSchema, isEnabled, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, setSchema, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeNullField, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeOmittedField, writePOJO, writePOJOField, writeRaw, writeStartArray, writeStartArray, writeStartArray, writeStartObject, writeString, writeStringField, writeTypePrefix, writeTypeSuffix
-
Field Details
-
MIN_INT_AS_LONG
protected static final long MIN_INT_AS_LONG- See Also:
-
MAX_INT_AS_LONG
protected static final long MAX_INT_AS_LONG- See Also:
-
PLAIN_NUMBER_P
-
TAG_BINARY
-
_ioContext
protected final com.fasterxml.jackson.core.io.IOContext _ioContext -
_formatFeatures
protected int _formatFeaturesBit flag composed of bits that indicate whichYAMLGenerator.Feature
s are enabled. -
_writer
-
_outputOptions
protected org.yaml.snakeyaml.DumperOptions _outputOptions -
_docVersion
protected final org.yaml.snakeyaml.DumperOptions.Version _docVersion -
STYLE_UNQUOTED_NAME
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_UNQUOTED_NAME -
STYLE_SCALAR
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_SCALAR -
STYLE_QUOTED
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_QUOTED -
STYLE_LITERAL
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_LITERAL -
STYLE_BASE64
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_BASE64 -
STYLE_PLAIN
private static final org.yaml.snakeyaml.DumperOptions.ScalarStyle STYLE_PLAIN -
_emitter
protected org.yaml.snakeyaml.emitter.Emitter _emitter -
_objectId
YAML supports native Object identifiers, so databinder may indicate need to output one. -
_typeId
YAML supports native Type identifiers, so databinder may indicate need to output one. -
_rootValueCount
protected int _rootValueCount -
_quotingChecker
-
NO_TAGS
private static final org.yaml.snakeyaml.events.ImplicitTuple NO_TAGS -
EXPLICIT_TAGS
private static final org.yaml.snakeyaml.events.ImplicitTuple EXPLICIT_TAGS
-
-
Constructor Details
-
YAMLGenerator
public YAMLGenerator(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions.Version version) throws IOException - Throws:
IOException
-
YAMLGenerator
public YAMLGenerator(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, StringQuotingChecker quotingChecker, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions dumperOptions) throws IOException - Throws:
IOException
- Since:
- 2.14
-
YAMLGenerator
@Deprecated public YAMLGenerator(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int yamlFeatures, com.fasterxml.jackson.core.ObjectCodec codec, Writer out, org.yaml.snakeyaml.DumperOptions.Version version) throws IOException Deprecated.- Throws:
IOException
-
-
Method Details
-
buildDumperOptions
protected org.yaml.snakeyaml.DumperOptions buildDumperOptions(int jsonFeatures, int yamlFeatures, org.yaml.snakeyaml.DumperOptions.Version version) -
version
public com.fasterxml.jackson.core.Version version()- Specified by:
version
in interfacecom.fasterxml.jackson.core.Versioned
- Overrides:
version
in classcom.fasterxml.jackson.core.base.GeneratorBase
-
useDefaultPrettyPrinter
Not sure what to do here; could reset indentation to some value maybe?- Overrides:
useDefaultPrettyPrinter
in classcom.fasterxml.jackson.core.base.GeneratorBase
-
setPrettyPrinter
Not sure what to do here; will always indent, but uses YAML-specific settings etc.- Overrides:
setPrettyPrinter
in classcom.fasterxml.jackson.core.JsonGenerator
-
getOutputTarget
- Overrides:
getOutputTarget
in classcom.fasterxml.jackson.core.JsonGenerator
-
getOutputBuffered
public int getOutputBuffered()SnakeYAML does not expose buffered content amount, so we can only return-1
from here- Overrides:
getOutputBuffered
in classcom.fasterxml.jackson.core.JsonGenerator
-
getFormatFeatures
public int getFormatFeatures()- Overrides:
getFormatFeatures
in classcom.fasterxml.jackson.core.JsonGenerator
-
overrideFormatFeatures
public com.fasterxml.jackson.core.JsonGenerator overrideFormatFeatures(int values, int mask) - Overrides:
overrideFormatFeatures
in classcom.fasterxml.jackson.core.JsonGenerator
-
canUseSchema
public boolean canUseSchema(com.fasterxml.jackson.core.FormatSchema schema) - Overrides:
canUseSchema
in classcom.fasterxml.jackson.core.JsonGenerator
-
canWriteFormattedNumbers
public boolean canWriteFormattedNumbers()- Overrides:
canWriteFormattedNumbers
in classcom.fasterxml.jackson.core.JsonGenerator
-
getWriteCapabilities
public com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> getWriteCapabilities()- Overrides:
getWriteCapabilities
in classcom.fasterxml.jackson.core.JsonGenerator
-
enable
-
disable
-
isEnabled
-
configure
-
writeFieldName
- Specified by:
writeFieldName
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeFieldName
public final void writeFieldName(com.fasterxml.jackson.core.SerializableString name) throws IOException - Overrides:
writeFieldName
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeFieldId
- Overrides:
writeFieldId
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
_writeFieldName
- Throws:
IOException
-
flush
- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeStartArray
- Specified by:
writeStartArray
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeEndArray
- Specified by:
writeEndArray
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeStartObject
- Specified by:
writeStartObject
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeEndObject
- Specified by:
writeEndObject
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeString
public void writeString(String text) throws IOException, com.fasterxml.jackson.core.JsonGenerationException - Specified by:
writeString
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
-
writeString
- Specified by:
writeString
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeString
public final void writeString(com.fasterxml.jackson.core.SerializableString sstr) throws IOException - Overrides:
writeString
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeRawUTF8String
- Specified by:
writeRawUTF8String
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeUTF8String
- Specified by:
writeUTF8String
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValue
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValue
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValue
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
writeBinary
public void writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data, int offset, int len) throws IOException - Specified by:
writeBinary
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeBoolean
- Specified by:
writeBoolean
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
- Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeNumber
public void writeNumber(String encodedValue) throws IOException, com.fasterxml.jackson.core.JsonGenerationException, UnsupportedOperationException - Specified by:
writeNumber
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
UnsupportedOperationException
-
writeNull
- Specified by:
writeNull
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
canWriteObjectId
public boolean canWriteObjectId()- Overrides:
canWriteObjectId
in classcom.fasterxml.jackson.core.JsonGenerator
-
canWriteTypeId
public boolean canWriteTypeId()- Overrides:
canWriteTypeId
in classcom.fasterxml.jackson.core.JsonGenerator
-
writeTypeId
- Overrides:
writeTypeId
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeObjectRef
- Overrides:
writeObjectRef
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
writeObjectId
- Overrides:
writeObjectId
in classcom.fasterxml.jackson.core.JsonGenerator
- Throws:
IOException
-
_verifyValueWrite
- Specified by:
_verifyValueWrite
in classcom.fasterxml.jackson.core.base.GeneratorBase
- Throws:
IOException
-
_releaseBuffers
protected void _releaseBuffers()- Specified by:
_releaseBuffers
in classcom.fasterxml.jackson.core.base.GeneratorBase
-
_writeScalar
protected void _writeScalar(String value, String type, org.yaml.snakeyaml.DumperOptions.ScalarStyle style) throws IOException - Throws:
IOException
-
_writeScalarBinary
private void _writeScalarBinary(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data) throws IOException - Throws:
IOException
-
_scalarEvent
protected org.yaml.snakeyaml.events.ScalarEvent _scalarEvent(String value, org.yaml.snakeyaml.DumperOptions.ScalarStyle style) -
_base64encode
-
_lf
-
_emitStartDocument
- Throws:
IOException
-
_emitEndDocument
- Throws:
IOException
-
_emit
- Throws:
IOException
-