com.fasterxml.jackson.dataformat.yaml

Class YAMLFactory

java.lang.Object

com.fasterxml.jackson.core.JsonFactory

com.fasterxml.jackson.dataformat.yaml.YAMLFactory

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, java.io.Serializable

public class YAMLFactory
extends com.fasterxml.jackson.core.JsonFactory

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonFactory

com.fasterxml.jackson.core.JsonFactory.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected org.yaml.snakeyaml.DumperOptions	_outputOptions
protected org.yaml.snakeyaml.DumperOptions.Version	_version
protected int	_yamlGeneratorFeatures
protected int	_yamlParserFeatures
protected static int	DEFAULT_YAML_GENERATOR_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.
protected static int	DEFAULT_YAML_PARSER_FEATURE_FLAGS Bitfield (set of flags) of all parser features that are enabled by default.
static java.lang.String	FORMAT_NAME_YAML Name used to identify YAML format.
protected java.nio.charset.Charset	UTF8

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

_characterEscapes, _factoryFeatures, _generatorFeatures, _inputDecorator, _objectCodec, _outputDecorator, _parserFeatures, _recyclerRef, _rootByteSymbols, _rootCharSymbols, _rootValueSeparator, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS, FORMAT_NAME_JSON

Constructor Summary

Constructors

Constructor and Description
YAMLFactory() Default constructor used to create factory instances.
YAMLFactory(com.fasterxml.jackson.core.ObjectCodec oc)
YAMLFactory(YAMLFactory src, com.fasterxml.jackson.core.ObjectCodec oc)

Method Summary

Methods

Modifier and Type	Method and Description
protected YAMLGenerator	_createGenerator(java.io.Writer out, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLGenerator	_createJsonGenerator(java.io.Writer out, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLParser	_createJsonParser(byte[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLParser	_createJsonParser(java.io.InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt)
protected com.fasterxml.jackson.core.JsonParser	_createJsonParser(java.io.Reader r, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLParser	_createParser(byte[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLParser	_createParser(java.io.InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLParser	_createParser(java.io.Reader r, com.fasterxml.jackson.core.io.IOContext ctxt)
protected java.io.Reader	_createReader(byte[] data, int offset, int len, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
protected java.io.Reader	_createReader(java.io.InputStream in, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLGenerator	_createUTF8Generator(java.io.OutputStream out, com.fasterxml.jackson.core.io.IOContext ctxt)
protected YAMLGenerator	_createUTF8JsonGenerator(java.io.OutputStream out, com.fasterxml.jackson.core.io.IOContext ctxt) Deprecated.
protected java.io.Writer	_createWriter(java.io.OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt)
YAMLFactory	configure(YAMLGenerator.Feature f, boolean state) Method for enabling or disabling specified generator feature (check YAMLGenerator.Feature for list of features)
YAMLFactory	configure(YAMLParser.Feature f, boolean state) Method for enabling or disabling specified parser feature (check YAMLParser.Feature for list of features)
YAMLFactory	copy()
YAMLGenerator	createGenerator(java.io.OutputStream out)
YAMLGenerator	createGenerator(java.io.OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc)
YAMLGenerator	createGenerator(java.io.Writer out)
YAMLGenerator	createJsonGenerator(java.io.OutputStream out) Deprecated.
YAMLGenerator	createJsonGenerator(java.io.OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc) Deprecated.
YAMLGenerator	createJsonGenerator(java.io.Writer out) Deprecated.
YAMLParser	createJsonParser(byte[] data) Deprecated.
YAMLParser	createJsonParser(byte[] data, int offset, int len) Deprecated.
YAMLParser	createJsonParser(java.io.File f) Deprecated.
YAMLParser	createJsonParser(java.io.InputStream in) Deprecated.
com.fasterxml.jackson.core.JsonParser	createJsonParser(java.io.Reader r) Deprecated.
YAMLParser	createJsonParser(java.lang.String content) Deprecated.
YAMLParser	createJsonParser(java.net.URL url) Deprecated.
YAMLParser	createParser(byte[] data)
YAMLParser	createParser(byte[] data, int offset, int len)
YAMLParser	createParser(java.io.File f)
YAMLParser	createParser(java.io.InputStream in)
com.fasterxml.jackson.core.JsonParser	createParser(java.io.Reader r)
YAMLParser	createParser(java.lang.String content)
YAMLParser	createParser(java.net.URL url)
YAMLFactory	disable(YAMLGenerator.Feature f) Method for disabling specified generator feature (check YAMLGenerator.Feature for list of features)
YAMLFactory	disable(YAMLParser.Feature f) Method for disabling specified parser features (check YAMLParser.Feature for list of features)
YAMLFactory	enable(YAMLGenerator.Feature f) Method for enabling specified generator features (check YAMLGenerator.Feature for list of features)
YAMLFactory	enable(YAMLParser.Feature f) Method for enabling specified parser feature (check YAMLParser.Feature for list of features)
java.lang.String	getFormatName()
com.fasterxml.jackson.core.format.MatchStrength	hasFormat(com.fasterxml.jackson.core.format.InputAccessor acc) Sub-classes need to override this method (as of 1.8)
boolean	isEnabled(YAMLGenerator.Feature f) Check whether specified generator feature is enabled.
boolean	isEnabled(YAMLParser.Feature f) Checked whether specified parser feature is enabled.
protected java.lang.Object	readResolve() Method that we need to override to actually make restoration go through constructors etc.
com.fasterxml.jackson.core.Version	version()

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

_checkInvalidCopy, _createContext, _getBufferRecycler, _optimizedStreamFromURL, canUseSchema, configure, configure, configure, createGenerator, createJsonGenerator, disable, disable, disable, enable, enable, enable, getCharacterEscapes, getCodec, getInputDecorator, getOutputDecorator, getRootValueSeparator, hasJSONFormat, isEnabled, isEnabled, isEnabled, requiresCustomCodec, setCharacterEscapes, setCodec, setInputDecorator, setOutputDecorator, setRootValueSeparator

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_NAME_YAML

public static final java.lang.String FORMAT_NAME_YAML

Name used to identify YAML format. (and returned by getFormatName()

See Also:

Constant Field Values

DEFAULT_YAML_PARSER_FEATURE_FLAGS

protected static final int DEFAULT_YAML_PARSER_FEATURE_FLAGS

Bitfield (set of flags) of all parser features that are enabled by default.

DEFAULT_YAML_GENERATOR_FEATURE_FLAGS

protected static final int DEFAULT_YAML_GENERATOR_FEATURE_FLAGS

Bitfield (set of flags) of all generator features that are enabled by default.

_yamlParserFeatures

protected int _yamlParserFeatures

_yamlGeneratorFeatures

protected int _yamlGeneratorFeatures

_outputOptions

protected transient org.yaml.snakeyaml.DumperOptions _outputOptions

_version

protected org.yaml.snakeyaml.DumperOptions.Version _version

UTF8

protected final java.nio.charset.Charset UTF8

Constructor Detail

YAMLFactory

public YAMLFactory()

Default constructor used to create factory instances. Creation of a factory instance is a light-weight operation, but it is still a good idea to reuse limited number of factory instances (and quite often just a single instance): factories are used as context for storing some reused processing objects (such as symbol tables parsers use) and this reuse only works within context of a single factory instance.

YAMLFactory

public YAMLFactory(com.fasterxml.jackson.core.ObjectCodec oc)

YAMLFactory

public YAMLFactory(YAMLFactory src,
           com.fasterxml.jackson.core.ObjectCodec oc)

Since:

2.2.1

Method Detail

copy

public YAMLFactory copy()

Overrides:

copy in class com.fasterxml.jackson.core.JsonFactory

readResolve

protected java.lang.Object readResolve()

Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well.

Overrides:

readResolve in class com.fasterxml.jackson.core.JsonFactory

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.JsonFactory

getFormatName

public java.lang.String getFormatName()

Overrides:

getFormatName in class com.fasterxml.jackson.core.JsonFactory

hasFormat

public com.fasterxml.jackson.core.format.MatchStrength hasFormat(com.fasterxml.jackson.core.format.InputAccessor acc)
                                                          throws java.io.IOException

Sub-classes need to override this method (as of 1.8)

Overrides:

hasFormat in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

configure

public final YAMLFactory configure(YAMLParser.Feature f,
                    boolean state)

Method for enabling or disabling specified parser feature (check YAMLParser.Feature for list of features)

enable

public YAMLFactory enable(YAMLParser.Feature f)

Method for enabling specified parser feature (check YAMLParser.Feature for list of features)

disable

public YAMLFactory disable(YAMLParser.Feature f)

Method for disabling specified parser features (check YAMLParser.Feature for list of features)

isEnabled

public final boolean isEnabled(YAMLParser.Feature f)

Checked whether specified parser feature is enabled.

configure

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

Method for enabling or disabling specified generator feature (check YAMLGenerator.Feature for list of features)

enable

public YAMLFactory enable(YAMLGenerator.Feature f)

Method for enabling specified generator features (check YAMLGenerator.Feature for list of features)

disable

public YAMLFactory disable(YAMLGenerator.Feature f)

Method for disabling specified generator feature (check YAMLGenerator.Feature for list of features)

isEnabled

public final boolean isEnabled(YAMLGenerator.Feature f)

Check whether specified generator feature is enabled.

createParser

public YAMLParser createParser(java.lang.String content)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public YAMLParser createParser(java.io.File f)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public YAMLParser createParser(java.net.URL url)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public YAMLParser createParser(java.io.InputStream in)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public com.fasterxml.jackson.core.JsonParser createParser(java.io.Reader r)
                                                   throws java.io.IOException,
                                                          com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public YAMLParser createParser(byte[] data)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createParser

public YAMLParser createParser(byte[] data,
                      int offset,
                      int len)
                        throws java.io.IOException,
                               com.fasterxml.jackson.core.JsonParseException

Overrides:

createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(java.lang.String content)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(java.io.File f)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(java.net.URL url)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(java.io.InputStream in)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public com.fasterxml.jackson.core.JsonParser createJsonParser(java.io.Reader r)
                                                       throws java.io.IOException,
                                                              com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(byte[] data)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createJsonParser

@Deprecated
public YAMLParser createJsonParser(byte[] data,
                                     int offset,
                                     int len)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Deprecated.

Overrides:

createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

createGenerator

public YAMLGenerator createGenerator(java.io.OutputStream out,
                            com.fasterxml.jackson.core.JsonEncoding enc)
                              throws java.io.IOException

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

createGenerator

public YAMLGenerator createGenerator(java.io.OutputStream out)
                              throws java.io.IOException

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

createGenerator

public YAMLGenerator createGenerator(java.io.Writer out)
                              throws java.io.IOException

Overrides:

createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

createJsonGenerator

@Deprecated
public YAMLGenerator createJsonGenerator(java.io.OutputStream out,
                                           com.fasterxml.jackson.core.JsonEncoding enc)
                                  throws java.io.IOException

Deprecated.

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

createJsonGenerator

@Deprecated
public YAMLGenerator createJsonGenerator(java.io.OutputStream out)
                                  throws java.io.IOException

Deprecated.

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

createJsonGenerator

@Deprecated
public YAMLGenerator createJsonGenerator(java.io.Writer out)
                                  throws java.io.IOException

Deprecated.

Overrides:

createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createParser

protected YAMLParser _createParser(java.io.InputStream in,
                       com.fasterxml.jackson.core.io.IOContext ctxt)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createParser

protected YAMLParser _createParser(java.io.Reader r,
                       com.fasterxml.jackson.core.io.IOContext ctxt)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createParser

protected YAMLParser _createParser(byte[] data,
                       int offset,
                       int len,
                       com.fasterxml.jackson.core.io.IOContext ctxt)
                            throws java.io.IOException,
                                   com.fasterxml.jackson.core.JsonParseException

Overrides:

_createParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createJsonParser

protected YAMLParser _createJsonParser(java.io.InputStream in,
                           com.fasterxml.jackson.core.io.IOContext ctxt)
                                throws java.io.IOException,
                                       com.fasterxml.jackson.core.JsonParseException

Overrides:

_createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createJsonParser

protected com.fasterxml.jackson.core.JsonParser _createJsonParser(java.io.Reader r,
                                                      com.fasterxml.jackson.core.io.IOContext ctxt)
                                                           throws java.io.IOException,
                                                                  com.fasterxml.jackson.core.JsonParseException

Overrides:

_createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createJsonParser

protected YAMLParser _createJsonParser(byte[] data,
                           int offset,
                           int len,
                           com.fasterxml.jackson.core.io.IOContext ctxt)
                                throws java.io.IOException,
                                       com.fasterxml.jackson.core.JsonParseException

Overrides:

_createJsonParser in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

com.fasterxml.jackson.core.JsonParseException

_createGenerator

protected YAMLGenerator _createGenerator(java.io.Writer out,
                             com.fasterxml.jackson.core.io.IOContext ctxt)
                                  throws java.io.IOException

Overrides:

_createGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createJsonGenerator

protected YAMLGenerator _createJsonGenerator(java.io.Writer out,
                                 com.fasterxml.jackson.core.io.IOContext ctxt)
                                      throws java.io.IOException

Overrides:

_createJsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createUTF8Generator

protected YAMLGenerator _createUTF8Generator(java.io.OutputStream out,
                                 com.fasterxml.jackson.core.io.IOContext ctxt)
                                      throws java.io.IOException

Overrides:

_createUTF8Generator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createUTF8JsonGenerator

@Deprecated
protected YAMLGenerator _createUTF8JsonGenerator(java.io.OutputStream out,
                                                com.fasterxml.jackson.core.io.IOContext ctxt)
                                          throws java.io.IOException

Deprecated.

Overrides:

_createUTF8JsonGenerator in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createWriter

protected java.io.Writer _createWriter(java.io.OutputStream out,
                           com.fasterxml.jackson.core.JsonEncoding enc,
                           com.fasterxml.jackson.core.io.IOContext ctxt)
                                throws java.io.IOException

Overrides:

_createWriter in class com.fasterxml.jackson.core.JsonFactory

Throws:

java.io.IOException

_createReader

protected java.io.Reader _createReader(java.io.InputStream in,
                           com.fasterxml.jackson.core.JsonEncoding enc,
                           com.fasterxml.jackson.core.io.IOContext ctxt)
                                throws java.io.IOException

Throws:

java.io.IOException

_createReader

protected java.io.Reader _createReader(byte[] data,
                           int offset,
                           int len,
                           com.fasterxml.jackson.core.JsonEncoding enc,
                           com.fasterxml.jackson.core.io.IOContext ctxt)
                                throws java.io.IOException

Throws:

java.io.IOException