Class YAMLFactory
java.lang.Object
com.fasterxml.jackson.core.TokenStreamFactory
com.fasterxml.jackson.core.JsonFactory
com.fasterxml.jackson.dataformat.yaml.YAMLFactory
- All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned
,Serializable
public class YAMLFactory
extends com.fasterxml.jackson.core.JsonFactory
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonFactory
com.fasterxml.jackson.core.JsonFactory.Feature
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.yaml.snakeyaml.DumperOptions
Configuration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).protected final org.yaml.snakeyaml.LoaderOptions
Configuration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).protected final StringQuotingChecker
Helper object used to determine whether property names, String values must be quoted or not.protected final org.yaml.snakeyaml.DumperOptions.Version
YAML version for underlying generator to follow, if specified.protected int
protected int
protected static final int
Bitfield (set of flags) of all generator features that are enabled by default.protected static final int
Bitfield (set of flags) of all parser features that are enabled by default.static final String
Name used to identify YAML format.private static final long
private static final byte
private static final byte
private static final byte
Fields inherited from class com.fasterxml.jackson.core.JsonFactory
_byteSymbolCanonicalizer, _characterEscapes, _factoryFeatures, _generatorFeatures, _inputDecorator, _maximumNonEscapedChar, _objectCodec, _outputDecorator, _parserFeatures, _quoteChar, _rootCharSymbols, _rootValueSeparator, _streamReadConstraints, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS, DEFAULT_QUOTE_CHAR, DEFAULT_ROOT_VALUE_SEPARATOR, FORMAT_NAME_JSON
-
Constructor Summary
ConstructorsModifierConstructorDescriptionDefault constructor used to create factory instances.YAMLFactory
(com.fasterxml.jackson.core.ObjectCodec oc) protected
Constructors used byYAMLFactoryBuilder
for instantiation.YAMLFactory
(YAMLFactory src, com.fasterxml.jackson.core.ObjectCodec oc) -
Method Summary
Modifier and TypeMethodDescriptionprotected YAMLGenerator
_createGenerator
(Writer out, 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
(char[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt, boolean recyclable) protected YAMLParser
_createParser
(InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt) protected YAMLParser
_createParser
(Reader r, com.fasterxml.jackson.core.io.IOContext ctxt) protected Reader
_createReader
(byte[] data, int offset, int len, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) protected Reader
_createReader
(InputStream in, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) protected YAMLGenerator
_createUTF8Generator
(OutputStream out, com.fasterxml.jackson.core.io.IOContext ctxt) protected Writer
_createWriter
(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) static YAMLFactoryBuilder
builder()
Main factory method to use for constructingYAMLFactory
instances with different configuration.boolean
final YAMLFactory
configure
(YAMLGenerator.Feature f, boolean state) Method for enabling or disabling specified generator feature (checkYAMLGenerator.Feature
for list of features)final YAMLFactory
configure
(YAMLParser.Feature f, boolean state) Method for enabling or disabling specified parser feature (checkYAMLParser.Feature
for list of features)copy()
com.fasterxml.jackson.core.JsonGenerator
createGenerator
(File f, com.fasterxml.jackson.core.JsonEncoding enc) createGenerator
(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc) createGenerator
(Writer out) createParser
(byte[] data) createParser
(byte[] data, int offset, int len) createParser
(char[] data) createParser
(char[] data, int offset, int len) createParser
(File f) createParser
(String content) createParser
(URL url) Method for disabling specified generator feature (checkYAMLGenerator.Feature
for list of features)Method for disabling specified parser features (checkYAMLParser.Feature
for list of features)Method for enabling specified generator features (checkYAMLGenerator.Feature
for list of features)Method for enabling specified parser feature (checkYAMLParser.Feature
for list of features)int
int
com.fasterxml.jackson.core.format.MatchStrength
hasFormat
(com.fasterxml.jackson.core.format.InputAccessor acc) Sub-classes need to override this methodfinal boolean
Check whether specified generator feature is enabled.final boolean
Checked whether specified parser feature is enabled.protected Object
Method that we need to override to actually make restoration go through constructors etc.rebuild()
com.fasterxml.jackson.core.Version
version()
Methods inherited from class com.fasterxml.jackson.core.JsonFactory
_checkInvalidCopy, _createContentReference, _createContentReference, _createContext, _createContext, _createNonBlockingContext, _createParser, _decorate, _decorate, _decorate, _decorate, _decorate, _getBufferRecycler, canHandleBinaryNatively, canParseAsync, canUseSchema, configure, configure, configure, createGenerator, createGenerator, createJsonGenerator, createJsonGenerator, createJsonGenerator, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createJsonParser, createNonBlockingByteArrayParser, createNonBlockingByteBufferParser, createParser, disable, disable, disable, enable, enable, enable, getCharacterEscapes, getCodec, getGeneratorFeatures, getInputDecorator, getOutputDecorator, getParserFeatures, getRootValueSeparator, hasJSONFormat, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, requiresCustomCodec, requiresPropertyOrdering, setCharacterEscapes, setCodec, setInputDecorator, setOutputDecorator, setRootValueSeparator, setStreamReadConstraints, streamReadConstraints
Methods inherited from class com.fasterxml.jackson.core.TokenStreamFactory
_checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _createDataOutputWrapper, _fileInputStream, _fileOutputStream, _optimizedStreamFromURL, _reportRangeError
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
FORMAT_NAME_YAML
Name used to identify YAML format. (and returned bygetFormatName()
- See Also:
-
DEFAULT_YAML_PARSER_FEATURE_FLAGS
protected static final int DEFAULT_YAML_PARSER_FEATURE_FLAGSBitfield (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_FLAGSBitfield (set of flags) of all generator features that are enabled by default. -
UTF8_BOM_1
private static final byte UTF8_BOM_1- See Also:
-
UTF8_BOM_2
private static final byte UTF8_BOM_2- See Also:
-
UTF8_BOM_3
private static final byte UTF8_BOM_3- See Also:
-
_yamlGeneratorFeatures
protected int _yamlGeneratorFeatures -
_yamlParserFeatures
protected int _yamlParserFeatures -
_version
protected final org.yaml.snakeyaml.DumperOptions.Version _versionYAML version for underlying generator to follow, if specified.- Since:
- 2.12
-
_quotingChecker
Helper object used to determine whether property names, String values must be quoted or not.- Since:
- 2.12
-
_loaderOptions
protected final org.yaml.snakeyaml.LoaderOptions _loaderOptionsConfiguration for underlying parser to follow, if specified; left asnull
for backwards compatibility (which means whatever default settingsSnakeYAML
deems best).If you need to support parsing YAML files that are larger than 3Mb, it is recommended that you provide a LoaderOptions instance where you set the Codepoint Limit to a larger value than its 3Mb default.
- Since:
- 2.14
-
_dumperOptions
protected final org.yaml.snakeyaml.DumperOptions _dumperOptionsConfiguration for underlying generator to follow, if specified; left asnull
for backwards compatibility (which means the dumper options are derived based onYAMLGenerator.Feature
s).These
YAMLGenerator.Feature
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
- Since:
- 2.14
-
-
Constructor Details
-
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
- Since:
- 2.2
-
YAMLFactory
Constructors used byYAMLFactoryBuilder
for instantiation.- Since:
- 3.0
-
-
Method Details
-
rebuild
- Overrides:
rebuild
in classcom.fasterxml.jackson.core.JsonFactory
-
builder
Main factory method to use for constructingYAMLFactory
instances with different configuration. -
copy
- Overrides:
copy
in classcom.fasterxml.jackson.core.JsonFactory
-
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 classcom.fasterxml.jackson.core.JsonFactory
-
version
public com.fasterxml.jackson.core.Version version()- Specified by:
version
in interfacecom.fasterxml.jackson.core.Versioned
- Overrides:
version
in classcom.fasterxml.jackson.core.JsonFactory
-
canUseCharArrays
public boolean canUseCharArrays()- Overrides:
canUseCharArrays
in classcom.fasterxml.jackson.core.JsonFactory
-
getFormatReadFeatureType
- Overrides:
getFormatReadFeatureType
in classcom.fasterxml.jackson.core.JsonFactory
-
getFormatWriteFeatureType
- Overrides:
getFormatWriteFeatureType
in classcom.fasterxml.jackson.core.JsonFactory
-
getFormatName
- Overrides:
getFormatName
in classcom.fasterxml.jackson.core.JsonFactory
-
hasFormat
public com.fasterxml.jackson.core.format.MatchStrength hasFormat(com.fasterxml.jackson.core.format.InputAccessor acc) throws IOException Sub-classes need to override this method- Overrides:
hasFormat
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
configure
Method for enabling or disabling specified generator feature (checkYAMLGenerator.Feature
for list of features) -
enable
Method for enabling specified generator features (checkYAMLGenerator.Feature
for list of features) -
disable
Method for disabling specified generator feature (checkYAMLGenerator.Feature
for list of features) -
isEnabled
Check whether specified generator feature is enabled. -
getFormatGeneratorFeatures
public int getFormatGeneratorFeatures()- Overrides:
getFormatGeneratorFeatures
in classcom.fasterxml.jackson.core.JsonFactory
-
configure
Method for enabling or disabling specified parser feature (checkYAMLParser.Feature
for list of features) -
enable
Method for enabling specified parser feature (checkYAMLParser.Feature
for list of features) -
disable
Method for disabling specified parser features (checkYAMLParser.Feature
for list of features) -
isEnabled
Checked whether specified parser feature is enabled. -
getFormatParserFeatures
public int getFormatParserFeatures()- Overrides:
getFormatParserFeatures
in classcom.fasterxml.jackson.core.JsonFactory
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createParser
- Overrides:
createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createGenerator
public YAMLGenerator createGenerator(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc) throws IOException - Overrides:
createGenerator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createGenerator
- Overrides:
createGenerator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createGenerator
- Overrides:
createGenerator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
createGenerator
public com.fasterxml.jackson.core.JsonGenerator createGenerator(File f, com.fasterxml.jackson.core.JsonEncoding enc) throws IOException - Overrides:
createGenerator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createParser
protected YAMLParser _createParser(InputStream in, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createParser
protected YAMLParser _createParser(Reader r, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createParser
protected YAMLParser _createParser(char[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt, boolean recyclable) throws IOException - Overrides:
_createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createParser
protected YAMLParser _createParser(byte[] data, int offset, int len, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createParser
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createGenerator
protected YAMLGenerator _createGenerator(Writer out, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createGenerator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createUTF8Generator
protected YAMLGenerator _createUTF8Generator(OutputStream out, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createUTF8Generator
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createWriter
protected Writer _createWriter(OutputStream out, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Overrides:
_createWriter
in classcom.fasterxml.jackson.core.JsonFactory
- Throws:
IOException
-
_createReader
protected Reader _createReader(InputStream in, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Throws:
IOException
-
_createReader
protected Reader _createReader(byte[] data, int offset, int len, com.fasterxml.jackson.core.JsonEncoding enc, com.fasterxml.jackson.core.io.IOContext ctxt) throws IOException - Throws:
IOException
-