com.fasterxml.jackson.dataformat.yaml

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 Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.yaml.snakeyaml.emitter.Emitter	_emitter
protected com.fasterxml.jackson.core.io.IOContext	_ioContext
protected String	_objectId YAML supports native Object identifiers, so databinder may indicate need to output one.
protected org.yaml.snakeyaml.DumperOptions	_outputOptions
protected String	_typeId YAML supports native Type identifiers, so databinder may indicate need to output one.
protected Writer	_writer
protected int	_yamlFeatures Bit flag composed of bits that indicate which YAMLGenerator.Features are enabled.
protected static long	MAX_INT_AS_LONG
protected static long	MIN_INT_AS_LONG

Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase

_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

_cfgPrettyPrinter

Constructor Summary

Constructors

Constructor and Description
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)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.yaml.snakeyaml.DumperOptions	_outputOptions()
protected void	_releaseBuffers()
protected org.yaml.snakeyaml.events.ScalarEvent	_scalarEvent(String value, Character style)
protected void	_verifyValueWrite(String typeMsg)
protected void	_writeScalar(String value, String type, Character style)
boolean	canUseSchema(com.fasterxml.jackson.core.FormatSchema schema)
boolean	canWriteObjectId()
boolean	canWriteTypeId()
void	close()
YAMLGenerator	configure(YAMLGenerator.Feature f, boolean state)
YAMLGenerator	disable(YAMLGenerator.Feature f)
YAMLGenerator	enable(YAMLGenerator.Feature f)
void	flush()
Object	getOutputTarget()
boolean	isEnabled(YAMLGenerator.Feature f)
YAMLGenerator	setPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp) Not sure what to do here; will always indent, but uses YAML-specific settings etc.
YAMLGenerator	useDefaultPrettyPrinter() 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)
void	writeEndArray()
void	writeEndObject()
void	writeFieldName(com.fasterxml.jackson.core.SerializableString name)
void	writeFieldName(String name)
void	writeNull()
void	writeNumber(BigDecimal dec)
void	writeNumber(BigInteger v)
void	writeNumber(double d)
void	writeNumber(float f)
void	writeNumber(int i)
void	writeNumber(long l)
void	writeNumber(String encodedValue)
void	writeObjectId(Object id)
void	writeObjectRef(Object id)
void	writeRaw(char c)
void	writeRaw(char[] text, int offset, int len)
void	writeRaw(String text)
void	writeRaw(String text, int offset, int len)
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)
void	writeStartArray()
void	writeStartObject()
void	writeString(char[] text, int offset, int len)
void	writeString(com.fasterxml.jackson.core.SerializableString sstr)
void	writeString(String text)
void	writeStringField(String fieldName, String value)
void	writeTypeId(Object id)
void	writeUTF8String(byte[] text, int offset, int len)

Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase

disable, enable, getCodec, getFeatureMask, getOutputContext, isClosed, isEnabled, setCodec, setFeatureMask, writeBinary, writeObject, writeTree

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

_reportError, _reportUnsupportedOperation, _throwInternal, _writeSimpleObject, canOmitFields, canWriteBinaryNatively, configure, copyCurrentEvent, copyCurrentStructure, getCharacterEscapes, getHighestEscapedChar, getPrettyPrinter, getSchema, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeOmittedField, writeRaw, writeStartArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_INT_AS_LONG

protected static final long MIN_INT_AS_LONG

See Also:

Constant Field Values

MAX_INT_AS_LONG

protected static final long MAX_INT_AS_LONG

See Also:

Constant Field Values

_ioContext

protected final com.fasterxml.jackson.core.io.IOContext _ioContext

_yamlFeatures

protected int _yamlFeatures

Bit flag composed of bits that indicate which YAMLGenerator.Features are enabled.

_writer

protected Writer _writer

_outputOptions

protected org.yaml.snakeyaml.DumperOptions _outputOptions

_emitter

protected org.yaml.snakeyaml.emitter.Emitter _emitter

_objectId

protected String _objectId

YAML supports native Object identifiers, so databinder may indicate need to output one.

_typeId

protected String _typeId

YAML supports native Type identifiers, so databinder may indicate need to output one.

Constructor Detail

YAMLGenerator

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

Throws:

IOException

Method Detail

version

public com.fasterxml.jackson.core.Version version()

Specified by:

version in interface com.fasterxml.jackson.core.Versioned

Overrides:

version in class com.fasterxml.jackson.core.base.GeneratorBase

useDefaultPrettyPrinter

public YAMLGenerator useDefaultPrettyPrinter()

Not sure what to do here; could reset indentation to some value maybe?

Overrides:

useDefaultPrettyPrinter in class com.fasterxml.jackson.core.base.GeneratorBase

setPrettyPrinter

public YAMLGenerator setPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp)

Not sure what to do here; will always indent, but uses YAML-specific settings etc.

Overrides:

setPrettyPrinter in class com.fasterxml.jackson.core.JsonGenerator

getOutputTarget

public Object getOutputTarget()

Overrides:

getOutputTarget in class com.fasterxml.jackson.core.JsonGenerator

canUseSchema

public boolean canUseSchema(com.fasterxml.jackson.core.FormatSchema schema)

Overrides:

canUseSchema in class com.fasterxml.jackson.core.JsonGenerator

writeFieldName

public final void writeFieldName(String name)
                          throws IOException,
                                 com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeFieldName in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeFieldName

public final void writeFieldName(com.fasterxml.jackson.core.SerializableString name)
                          throws IOException,
                                 com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeFieldName in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeStringField

public final void writeStringField(String fieldName,
                    String value)
                            throws IOException,
                                   com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeStringField in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

enable

public YAMLGenerator enable(YAMLGenerator.Feature f)

disable

public YAMLGenerator disable(YAMLGenerator.Feature f)

isEnabled

public final boolean isEnabled(YAMLGenerator.Feature f)

configure

public YAMLGenerator configure(YAMLGenerator.Feature f,
                      boolean state)

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

writeStartArray

public final void writeStartArray()
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeStartArray in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeEndArray

public final void writeEndArray()
                         throws IOException,
                                com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeEndArray in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeStartObject

public final void writeStartObject()
                            throws IOException,
                                   com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeStartObject in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeEndObject

public final void writeEndObject()
                          throws IOException,
                                 com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeEndObject in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeString

public void writeString(String text)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeString in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeString

public void writeString(char[] text,
               int offset,
               int len)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeString in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeString

public final void writeString(com.fasterxml.jackson.core.SerializableString sstr)
                       throws IOException,
                              com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeString in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                      int offset,
                      int len)
                        throws IOException,
                               com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeRawUTF8String in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeUTF8String

public final void writeUTF8String(byte[] text,
                   int offset,
                   int len)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeUTF8String in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRaw

public void writeRaw(String text)
              throws IOException,
                     com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeRaw in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRaw

public void writeRaw(String text,
            int offset,
            int len)
              throws IOException,
                     com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeRaw in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRaw

public void writeRaw(char[] text,
            int offset,
            int len)
              throws IOException,
                     com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeRaw in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRaw

public void writeRaw(char c)
              throws IOException,
                     com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeRaw in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRawValue

public void writeRawValue(String text)
                   throws IOException,
                          com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRawValue

public void writeRawValue(String text,
                 int offset,
                 int len)
                   throws IOException,
                          com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeRawValue

public void writeRawValue(char[] text,
                 int offset,
                 int len)
                   throws IOException,
                          com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeBinary

public void writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
               byte[] data,
               int offset,
               int len)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeBinary in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException,
                         com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeBoolean in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(int i)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(long l)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(BigInteger v)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(double d)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(float f)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(BigDecimal dec)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException,
                        UnsupportedOperationException

Specified by:

writeNumber in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

UnsupportedOperationException

writeNull

public void writeNull()
               throws IOException,
                      com.fasterxml.jackson.core.JsonGenerationException

Specified by:

writeNull in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

canWriteObjectId

public boolean canWriteObjectId()

Overrides:

canWriteObjectId in class com.fasterxml.jackson.core.JsonGenerator

canWriteTypeId

public boolean canWriteTypeId()

Overrides:

canWriteTypeId in class com.fasterxml.jackson.core.JsonGenerator

writeTypeId

public void writeTypeId(Object id)
                 throws IOException,
                        com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeTypeId in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeObjectRef

public void writeObjectRef(Object id)
                    throws IOException,
                           com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeObjectRef in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

writeObjectId

public void writeObjectId(Object id)
                   throws IOException,
                          com.fasterxml.jackson.core.JsonGenerationException

Overrides:

writeObjectId in class com.fasterxml.jackson.core.JsonGenerator

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

_verifyValueWrite

protected final void _verifyValueWrite(String typeMsg)
                                throws IOException,
                                       com.fasterxml.jackson.core.JsonGenerationException

Specified by:

_verifyValueWrite in class com.fasterxml.jackson.core.base.GeneratorBase

Throws:

IOException

com.fasterxml.jackson.core.JsonGenerationException

_releaseBuffers

protected void _releaseBuffers()

Specified by:

_releaseBuffers in class com.fasterxml.jackson.core.base.GeneratorBase

_writeScalar

protected void _writeScalar(String value,
                String type,
                Character style)
                     throws IOException

Throws:

IOException

_scalarEvent

protected org.yaml.snakeyaml.events.ScalarEvent _scalarEvent(String value,
                                                 Character style)

_outputOptions

protected org.yaml.snakeyaml.DumperOptions _outputOptions()