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 enumEnumeration that defines all togglable features for YAML generators -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.yaml.snakeyaml.DumperOptions.Versionprotected org.yaml.snakeyaml.emitter.Emitterprotected intBit flag composed of bits that indicate whichYAMLGenerator.Features are enabled.protected StringYAML supports native Object identifiers, so databinder may indicate need to output one.protected org.yaml.snakeyaml.DumperOptionsprotected final StringQuotingCheckerprotected intprotected final com.fasterxml.jackson.core.StreamWriteConstraintsprotected StringYAML supports native Type identifiers, so databinder may indicate need to output one.protected Writerprivate static final org.yaml.snakeyaml.events.ImplicitTupleprotected static final longprotected static final longprivate static final org.yaml.snakeyaml.events.ImplicitTupleprotected static final Patternprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprivate static final org.yaml.snakeyaml.DumperOptions.ScalarStyleprotected static final StringFields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cfgNumbersAsStrings, _closed, _features, _ioContext, _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_STRINGFields 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 voidprotected voidprotected String_lf()protected voidprotected 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.DumperOptionsbuildDumperOptions(int jsonFeatures, int yamlFeatures, org.yaml.snakeyaml.DumperOptions.Version version) booleancanUseSchema(com.fasterxml.jackson.core.FormatSchema schema) booleanbooleanbooleanvoidclose()configure(YAMLGenerator.Feature f, boolean state) final voidflush()intintSnakeYAML does not expose buffered content amount, so we can only return-1from herecom.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> final booleancom.fasterxml.jackson.core.JsonGeneratoroverrideFormatFeatures(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.com.fasterxml.jackson.core.StreamWriteConstraintsNot sure what to do here; could reset indentation to some value maybe?com.fasterxml.jackson.core.Versionversion()voidwriteBinary(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data, int offset, int len) voidwriteBoolean(boolean state) final voidfinal voidvoidwriteFieldId(long id) final voidwriteFieldName(com.fasterxml.jackson.core.SerializableString name) final voidwriteFieldName(String name) voidvoidwriteNumber(double d) voidwriteNumber(float f) voidwriteNumber(int i) voidwriteNumber(long l) voidwriteNumber(String encodedValue) voidwriteNumber(BigDecimal dec) voidvoidwriteObjectId(Object id) voidwriteObjectRef(Object id) voidwriteRaw(char c) voidwriteRaw(char[] text, int offset, int len) voidvoidvoidwriteRawUTF8String(byte[] text, int offset, int len) voidwriteRawValue(char[] text, int offset, int len) voidwriteRawValue(String text) voidwriteRawValue(String text, int offset, int len) final voidfinal voidvoidwriteString(char[] text, int offset, int len) final voidwriteString(com.fasterxml.jackson.core.SerializableString sstr) voidwriteString(String text) voidwriteTypeId(Object id) final voidwriteUTF8String(byte[] text, int offset, int len) Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_asString, _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _checkRangeBoundsForString, _checkStdFeatureChanges, _constructDefaultPrettyPrinter, _decodeSurrogate, assignCurrentValue, currentValue, disable, enable, getCodec, getFeatureMask, getOutputContext, ioContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setFeatureMask, writeBinary, writeObject, writeRawValue, writeStartObject, writeTreeMethods inherited from class com.fasterxml.jackson.core.JsonGenerator
_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, canOmitFields, canWriteBinaryNatively, configure, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, getCharacterEscapes, getCurrentValue, getHighestEscapedChar, getPrettyPrinter, getSchema, isEnabled, setCharacterEscapes, setCurrentValue, 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
-
_streamWriteConstraints
protected final com.fasterxml.jackson.core.StreamWriteConstraints _streamWriteConstraints- Since:
- 2.16
-
_formatFeatures
protected int _formatFeaturesBit flag composed of bits that indicate whichYAMLGenerator.Features 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) -
streamWriteConstraints
public com.fasterxml.jackson.core.StreamWriteConstraints streamWriteConstraints()- Overrides:
streamWriteConstraintsin classcom.fasterxml.jackson.core.JsonGenerator
-
version
public com.fasterxml.jackson.core.Version version()- Specified by:
versionin interfacecom.fasterxml.jackson.core.Versioned- Overrides:
versionin classcom.fasterxml.jackson.core.base.GeneratorBase
-
useDefaultPrettyPrinter
Not sure what to do here; could reset indentation to some value maybe?- Overrides:
useDefaultPrettyPrinterin classcom.fasterxml.jackson.core.base.GeneratorBase
-
setPrettyPrinter
Not sure what to do here; will always indent, but uses YAML-specific settings etc.- Overrides:
setPrettyPrinterin classcom.fasterxml.jackson.core.JsonGenerator
-
getOutputTarget
- Overrides:
getOutputTargetin classcom.fasterxml.jackson.core.JsonGenerator
-
getOutputBuffered
public int getOutputBuffered()SnakeYAML does not expose buffered content amount, so we can only return-1from here- Overrides:
getOutputBufferedin classcom.fasterxml.jackson.core.JsonGenerator
-
getFormatFeatures
public int getFormatFeatures()- Overrides:
getFormatFeaturesin classcom.fasterxml.jackson.core.JsonGenerator
-
overrideFormatFeatures
public com.fasterxml.jackson.core.JsonGenerator overrideFormatFeatures(int values, int mask) - Overrides:
overrideFormatFeaturesin classcom.fasterxml.jackson.core.JsonGenerator
-
canUseSchema
public boolean canUseSchema(com.fasterxml.jackson.core.FormatSchema schema) - Overrides:
canUseSchemain classcom.fasterxml.jackson.core.JsonGenerator
-
canWriteFormattedNumbers
public boolean canWriteFormattedNumbers()- Overrides:
canWriteFormattedNumbersin classcom.fasterxml.jackson.core.JsonGenerator
-
getWriteCapabilities
public com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> getWriteCapabilities()- Overrides:
getWriteCapabilitiesin classcom.fasterxml.jackson.core.JsonGenerator
-
enable
-
disable
-
isEnabled
-
configure
-
writeFieldName
- Specified by:
writeFieldNamein classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeFieldName
public final void writeFieldName(com.fasterxml.jackson.core.SerializableString name) throws IOException - Overrides:
writeFieldNamein classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
writeFieldId
- Overrides:
writeFieldIdin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
_writeFieldName
- Throws:
IOException
-
flush
- Specified by:
flushin interfaceFlushable- Specified by:
flushin classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
writeStartArray
- Specified by:
writeStartArrayin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeEndArray
- Specified by:
writeEndArrayin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeStartObject
- Specified by:
writeStartObjectin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeEndObject
- Specified by:
writeEndObjectin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeString
public void writeString(String text) throws IOException, com.fasterxml.jackson.core.JsonGenerationException - Specified by:
writeStringin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOExceptioncom.fasterxml.jackson.core.JsonGenerationException
-
writeString
- Specified by:
writeStringin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeString
public final void writeString(com.fasterxml.jackson.core.SerializableString sstr) throws IOException - Overrides:
writeStringin classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
writeRawUTF8String
- Specified by:
writeRawUTF8Stringin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeUTF8String
- Specified by:
writeUTF8Stringin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeRaw
- Specified by:
writeRawin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeRaw
- Specified by:
writeRawin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeRaw
- Specified by:
writeRawin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeRaw
- Specified by:
writeRawin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValuein classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValuein classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
writeRawValue
- Overrides:
writeRawValuein 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:
writeBinaryin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeBoolean
- Specified by:
writeBooleanin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
- Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeNumber
public void writeNumber(String encodedValue) throws IOException, com.fasterxml.jackson.core.JsonGenerationException, UnsupportedOperationException - Specified by:
writeNumberin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOExceptioncom.fasterxml.jackson.core.JsonGenerationExceptionUnsupportedOperationException
-
writeNull
- Specified by:
writeNullin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
canWriteObjectId
public boolean canWriteObjectId()- Overrides:
canWriteObjectIdin classcom.fasterxml.jackson.core.JsonGenerator
-
canWriteTypeId
public boolean canWriteTypeId()- Overrides:
canWriteTypeIdin classcom.fasterxml.jackson.core.JsonGenerator
-
writeTypeId
- Overrides:
writeTypeIdin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeObjectRef
- Overrides:
writeObjectRefin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
writeObjectId
- Overrides:
writeObjectIdin classcom.fasterxml.jackson.core.JsonGenerator- Throws:
IOException
-
_verifyValueWrite
- Specified by:
_verifyValueWritein classcom.fasterxml.jackson.core.base.GeneratorBase- Throws:
IOException
-
_releaseBuffers
protected void _releaseBuffers()- Specified by:
_releaseBuffersin 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
-