Jackson 3.0.1 · tools.jackson.dataformat.yaml.YAMLFactory

Modifier and Type	Field and Description
protected final DumpSettings	_dumpSettings Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLWriteFeature`s).
protected final LoadSettings	_loadSettings Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `snakeyaml-engine` deems best).
protected final StringQuotingChecker	_quotingChecker Helper object used to determine whether property names, String values must be quoted or not.
protected final SpecVersion	_version YAML version for underlying generator to follow, if specified.
protected static final int	DEFAULT_YAML_GENERATOR_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.
protected static final int	DEFAULT_YAML_PARSER_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.
public static final String	FORMAT_NAME_YAML Name used to identify YAML format.
private static final long	serialVersionUID Hides tools.jackson.core.base.TextualTSFactory.serialVersionUID.

Access	Constructor and Description
public	YAMLFactory() Default constructor used to create factory instances that may be used to construct an instance with default settings, instead of using `YAMLFactoryBuilder`.
public	YAMLFactory(YAMLFactory src)
protected	YAMLFactory(YAMLFactoryBuilder b) Constructors used by `YAMLFactoryBuilder` for instantiation.

Method Summary

Modifier and Type	Method and Description
protected YAMLGenerator	_createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, Writer out) Implements abstract tools.jackson.core.base.TextualTSFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object.
protected YAMLParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.
protected YAMLParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, Reader r) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.
protected YAMLParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.
protected YAMLParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.
protected JsonParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, DataInput input) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.
protected Reader	_createReader(InputStream in, JsonEncoding enc, IOContext ctxt)
protected Reader	_createReader(byte[] data, int offset, int len, JsonEncoding enc, IOContext ctxt)
protected YAMLGenerator	_createUTF8Generator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out) Implements abstract tools.jackson.core.base.TextualTSFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding.
protected Writer	_createWriter(IOContext ioCtxt, OutputStream out, JsonEncoding enc) Overrides tools.jackson.core.base.TextualTSFactory._createWriter.
public static YAMLFactoryBuilder	builder() Main factory method to use for constructing `YAMLFactory` instances with different configuration.
public boolean	canParseAsync() Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync. Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a `tools.jackson.core.async.NonBlockingInputFeeder`.
public boolean	canUseCharArrays() Overrides tools.jackson.core.base.TextualTSFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`.
public boolean	canUseSchema(FormatSchema schema) Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema. Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use.
public YAMLFactory	copy() Implements abstract tools.jackson.core.TokenStreamFactory.copy. Method similar to `snapshot()`, but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.
public String	getFormatName() Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName. Method that returns short textual id identifying format this factory supports.
public int	getFormatReadFeatures() Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatures.
public Class<YAMLReadFeature>	getFormatReadFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonParser` produced by this factory would accept, if any; `null` returned if none.
public int	getFormatWriteFeatures() Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatures.
public Class<YAMLWriteFeature>	getFormatWriteFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonGenerator` produced by this factory would accept, if any; `null` returned if none.
public boolean	isEnabled(YAMLReadFeature f)
public boolean	isEnabled(YAMLWriteFeature f)
protected Object	readResolve() Method that we need to override to actually make restoration go through constructors etc.
public YAMLFactoryBuilder	rebuild() Implements abstract tools.jackson.core.TokenStreamFactory.rebuild. Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.
public TokenStreamFactory	snapshot() Implements abstract tools.jackson.core.TokenStreamFactory.snapshot. Implements tools.jackson.core.util.Snapshottable.snapshot. Instances are immutable so just return `this`
public Version	version() Implements abstract tools.jackson.core.TokenStreamFactory.version. Implements tools.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details).

Inherited from tools.jackson.core.base.TextualTSFactory:: _createContentReference _createContentReference canHandleBinaryNatively createGenerator createGenerator createGenerator createGenerator createParser createParser createParser createParser createParser createParser createParser createParser

Field Detail

_dumpSettings back to summary

_dumpSettings	back to summary
protected final DumpSettings _dumpSettings Configuration for underlying generator to follow, if specified; left as `null` for backwards compatibility (which means the dumper options are derived based on `YAMLWriteFeature`s). These `YAMLWriteFeature`s are ignored if you provide your own DumperOptions: `YAMLGenerator.Feature.ALLOW_LONG_KEYS` `YAMLGenerator.Feature.CANONICAL_OUTPUT` `YAMLGenerator.Feature.INDENT_ARRAYS` `YAMLGenerator.Feature.INDENT_ARRAYS_WITH_INDICATOR` `YAMLGenerator.Feature.SPLIT_LINES` `YAMLGenerator.Feature.USE_PLATFORM_LINE_BREAKS`

protected final DumpSettings _dumpSettings

Configuration for underlying generator to follow, if specified; left as null for backwards compatibility (which means the dumper options are derived based on YAMLWriteFeatures).

These YAMLWriteFeatures are ignored if you provide your own DumperOptions:

YAMLGenerator.Feature.ALLOW_LONG_KEYS
YAMLGenerator.Feature.CANONICAL_OUTPUT
YAMLGenerator.Feature.INDENT_ARRAYS
YAMLGenerator.Feature.INDENT_ARRAYS_WITH_INDICATOR
YAMLGenerator.Feature.SPLIT_LINES
YAMLGenerator.Feature.USE_PLATFORM_LINE_BREAKS

_loadSettings	back to summary
protected final LoadSettings _loadSettings Configuration for underlying parser to follow, if specified; left as `null` for backwards compatibility (which means whatever default settings `snakeyaml-engine` deems best).

_quotingChecker	back to summary
protected final StringQuotingChecker _quotingChecker Helper object used to determine whether property names, String values must be quoted or not.

_version	back to summary
protected final SpecVersion _version YAML version for underlying generator to follow, if specified.

DEFAULT_YAML_GENERATOR_FEATURE_FLAGS	back to summary
protected static final int DEFAULT_YAML_GENERATOR_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.

DEFAULT_YAML_PARSER_FEATURE_FLAGS	back to summary
protected static final int DEFAULT_YAML_PARSER_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.

FORMAT_NAME_YAML	back to summary
public static final String FORMAT_NAME_YAML Name used to identify YAML format. (and returned by `getFormatName()`

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.core.base.TextualTSFactory.serialVersionUID.

Constructor Detail

YAMLFactory	back to summary
public YAMLFactory() Default constructor used to create factory instances that may be used to construct an instance with default settings, instead of using `YAMLFactoryBuilder`.

YAMLFactory	back to summary
public YAMLFactory(YAMLFactory src)

YAMLFactory back to summary

YAMLFactory	back to summary
protected YAMLFactory(YAMLFactoryBuilder b) Constructors used by `YAMLFactoryBuilder` for instantiation. Since 3.0

protected YAMLFactory(YAMLFactoryBuilder b)

Constructors used by YAMLFactoryBuilder for instantiation.

Since: 3.0

Method Detail

_createGenerator back to summary

_createGenerator	back to summary
protected YAMLGenerator _createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, Writer out) Implements abstract tools.jackson.core.base.TextualTSFactory._createGenerator. Doc from tools.jackson.core.base.TextualTSFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Annotations @Override

protected YAMLGenerator _createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, Writer out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createGenerator.

Doc from tools.jackson.core.base.TextualTSFactory._createGenerator.

Overridable factory method that actually instantiates generator for given Writer and context object.

This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations.

Annotations

@Override

_createParser	back to summary
protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations

@Override

_createParser	back to summary
protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, Reader r) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, Reader r)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations

@Override

_createParser	back to summary
protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations

@Override

_createParser	back to summary
protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected YAMLParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations

@Override

_createParser	back to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, DataInput input) Implements abstract tools.jackson.core.base.TextualTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, DataInput input)

Implements abstract tools.jackson.core.base.TextualTSFactory._createParser.

Annotations

@Override

_createReader	back to summary
protected Reader _createReader(InputStream in, JsonEncoding enc, IOContext ctxt)

_createReader	back to summary
protected Reader _createReader(byte[] data, int offset, int len, JsonEncoding enc, IOContext ctxt)

_createUTF8Generator back to summary

_createUTF8Generator	back to summary
protected YAMLGenerator _createUTF8Generator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out) Implements abstract tools.jackson.core.base.TextualTSFactory._createUTF8Generator. Doc from tools.jackson.core.base.TextualTSFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Annotations @Override

protected YAMLGenerator _createUTF8Generator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out)

Implements abstract tools.jackson.core.base.TextualTSFactory._createUTF8Generator.

Doc from tools.jackson.core.base.TextualTSFactory._createUTF8Generator.

Overridable factory method that actually instantiates generator for given OutputStream and context object, using UTF-8 encoding.

Annotations

@Override

_createWriter	back to summary
protected Writer _createWriter(IOContext ioCtxt, OutputStream out, JsonEncoding enc) Overrides tools.jackson.core.base.TextualTSFactory._createWriter. Annotations @Override

_createWriter

back to summary

protected Writer _createWriter(IOContext ioCtxt, OutputStream out, JsonEncoding enc)

Overrides tools.jackson.core.base.TextualTSFactory._createWriter.

Annotations

@Override

builder	back to summary
public static YAMLFactoryBuilder builder() Main factory method to use for constructing `YAMLFactory` instances with different configuration.

canParseAsync back to summary

canParseAsync	back to summary
public boolean canParseAsync() Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync. Doc from tools.jackson.core.TokenStreamFactory.canParseAsync. Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a `tools.jackson.core.async.NonBlockingInputFeeder`. Annotations @Override

public boolean canParseAsync()

Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync.

Doc from tools.jackson.core.TokenStreamFactory.canParseAsync.

Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a tools.jackson.core.async.NonBlockingInputFeeder.

Annotations

@Override

canUseCharArrays back to summary

canUseCharArrays	back to summary
public boolean canUseCharArrays() Overrides tools.jackson.core.base.TextualTSFactory.canUseCharArrays. Doc from tools.jackson.core.base.TextualTSFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access `java.lang.String` content by first copying it into recyclable intermediate buffer. Default implementation simply returns `true` Annotations @Override

public boolean canUseCharArrays()

Overrides tools.jackson.core.base.TextualTSFactory.canUseCharArrays.

Doc from tools.jackson.core.base.TextualTSFactory.canUseCharArrays.

Introspection method that can be used by base factory to check whether access using char[] is something that actual parser implementations can take advantage of, over having to use java.io.Reader. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access java.lang.String content by first copying it into recyclable intermediate buffer.

Default implementation simply returns true

Annotations

@Override

canUseSchema	back to summary
public boolean canUseSchema(FormatSchema schema) Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema. Doc from tools.jackson.core.TokenStreamFactory.canUseSchema. Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions. Annotations @Override

canUseSchema

back to summary

public boolean canUseSchema(FormatSchema schema)

Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema.

Doc from tools.jackson.core.TokenStreamFactory.canUseSchema.

Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions.

Annotations

@Override

copy back to summary

copy	back to summary
public YAMLFactory copy() Implements abstract tools.jackson.core.TokenStreamFactory.copy. Doc from tools.jackson.core.TokenStreamFactory.copy. Method similar to `snapshot()`, but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse. Implementation should be functionally equivalent to: factoryInstance.rebuild().build(); Annotations @Override

public YAMLFactory copy()

Implements abstract tools.jackson.core.TokenStreamFactory.copy.

Doc from tools.jackson.core.TokenStreamFactory.copy.

Method similar to snapshot(), but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.

Implementation should be functionally equivalent to:

    factoryInstance.rebuild().build();

Annotations

@Override

getFormatName	back to summary
public String getFormatName() Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName. Doc from tools.jackson.core.TokenStreamFactory.getFormatName. Method that returns short textual id identifying format this factory supports. Annotations @Override

getFormatName

back to summary

public String getFormatName()

Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName.

Doc from tools.jackson.core.TokenStreamFactory.getFormatName.

Method that returns short textual id identifying format this factory supports.

Annotations

@Override

getFormatReadFeatures	back to summary
public int getFormatReadFeatures() Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatures. Annotations @Override

getFormatReadFeatures

back to summary

public int getFormatReadFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatures.

Annotations

@Override

getFormatReadFeatureType back to summary

getFormatReadFeatureType	back to summary
public Class<YAMLReadFeature> getFormatReadFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType. Doc from tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonParser` produced by this factory would accept, if any; `null` returned if none. Annotations @Override

public Class<YAMLReadFeature> getFormatReadFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Doc from tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Method for accessing kind of FormatFeature that a parser JsonParser produced by this factory would accept, if any; null returned if none.

Annotations

@Override

getFormatWriteFeatures	back to summary
public int getFormatWriteFeatures() Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatures. Annotations @Override

getFormatWriteFeatures

back to summary

public int getFormatWriteFeatures()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatures.

Annotations

@Override

getFormatWriteFeatureType back to summary

getFormatWriteFeatureType	back to summary
public Class<YAMLWriteFeature> getFormatWriteFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType. Doc from tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonGenerator` produced by this factory would accept, if any; `null` returned if none. Annotations @Override

public Class<YAMLWriteFeature> getFormatWriteFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Doc from tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Method for accessing kind of FormatFeature that a parser JsonGenerator produced by this factory would accept, if any; null returned if none.

Annotations

@Override

isEnabled	back to summary
public boolean isEnabled(YAMLReadFeature f)

isEnabled	back to summary
public boolean isEnabled(YAMLWriteFeature f)

readResolve	back to summary
protected Object readResolve() Method that we need to override to actually make restoration go through constructors etc.

rebuild	back to summary
public YAMLFactoryBuilder rebuild() Implements abstract tools.jackson.core.TokenStreamFactory.rebuild. Doc from tools.jackson.core.TokenStreamFactory.rebuild. Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory. Annotations @Override

rebuild

back to summary

public YAMLFactoryBuilder rebuild()

Implements abstract tools.jackson.core.TokenStreamFactory.rebuild.

Doc from tools.jackson.core.TokenStreamFactory.rebuild.

Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.

Annotations

@Override

snapshot	back to summary
public TokenStreamFactory snapshot() Implements abstract tools.jackson.core.TokenStreamFactory.snapshot. Implements tools.jackson.core.util.Snapshottable.snapshot. Instances are immutable so just return `this` Annotations @Override

snapshot

back to summary

public TokenStreamFactory snapshot()

Implements abstract tools.jackson.core.TokenStreamFactory.snapshot.

Implements tools.jackson.core.util.Snapshottable.snapshot.

Instances are immutable so just return `this`

Annotations

@Override

version back to summary

version	back to summary
public Version version() Implements abstract tools.jackson.core.TokenStreamFactory.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.core.Versioned.version. Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see `Version` for details). Annotations @Override

public Version version()

Implements abstract tools.jackson.core.TokenStreamFactory.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.core.Versioned.version.

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Annotations

@Override

public Class YAMLFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail