Module tools.jackson.dataformat.yaml
Package tools.jackson.dataformat.yaml

Class YAMLFactory

java.lang.Object
tools.jackson.core.TokenStreamFactory
tools.jackson.core.base.DecorableTSFactory
tools.jackson.core.base.TextualTSFactory
tools.jackson.dataformat.yaml.YAMLFactory
All Implemented Interfaces:
Serializable, tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>, tools.jackson.core.Versioned
public class YAMLFactory extends tools.jackson.core.base.TextualTSFactory implements Serializable
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class tools.jackson.core.base.DecorableTSFactory

    tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder<F extends tools.jackson.core.TokenStreamFactory,T extends tools.jackson.core.TSFBuilder<F,T>>

    Nested classes/interfaces inherited from class tools.jackson.core.TokenStreamFactory

    tools.jackson.core.TokenStreamFactory.Feature

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.snakeyaml.engine.v2.api.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).
    protected final org.snakeyaml.engine.v2.api.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 org.snakeyaml.engine.v2.common.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.
    static final String
    FORMAT_NAME_YAML
    Name used to identify YAML format.

    Fields inherited from class tools.jackson.core.base.DecorableTSFactory

    _generatorDecorators, _inputDecorator, _outputDecorator

    Fields inherited from class tools.jackson.core.TokenStreamFactory

    _errorReportConfiguration, _factoryFeatures, _formatReadFeatures, _formatWriteFeatures, _recyclerPool, _streamReadConstraints, _streamReadFeatures, _streamWriteConstraints, _streamWriteFeatures, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_STREAM_READ_FEATURE_FLAGS, DEFAULT_STREAM_WRITE_FEATURE_FLAGS, EMPTY_WRITE_CONTEXT

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected YAMLGenerator
    _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, Writer out)
     
    protected YAMLParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, byte[] data, int offset, int len)
     
    protected YAMLParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)
     
    protected tools.jackson.core.JsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, DataInput input)
     
    protected YAMLParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, InputStream in)
     
    protected YAMLParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, Reader r)
     
    protected Reader
    _createReader(byte[] data, int offset, int len, tools.jackson.core.JsonEncoding enc, tools.jackson.core.io.IOContext ctxt)
     
    protected Reader
    _createReader(InputStream in, tools.jackson.core.JsonEncoding enc, tools.jackson.core.io.IOContext ctxt)
     
    protected YAMLGenerator
    _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, OutputStream out)
     
    protected Writer
    _createWriter(tools.jackson.core.io.IOContext ioCtxt, OutputStream out, tools.jackson.core.JsonEncoding enc)
     
    static YAMLFactoryBuilder
    builder()
    Main factory method to use for constructing YAMLFactory instances with different configuration.
    boolean
    canParseAsync()
     
    boolean
    canUseCharArrays()
     
    boolean
    canUseSchema(tools.jackson.core.FormatSchema schema)
     
    YAMLFactory
    copy()
     
    String
    getFormatName()
     
    int
    getFormatReadFeatures()
     
    Class<YAMLReadFeature>
    getFormatReadFeatureType()
     
    int
    getFormatWriteFeatures()
     
    Class<YAMLWriteFeature>
    getFormatWriteFeatureType()
     
    boolean
    isEnabled(YAMLReadFeature f)
     
    boolean
    isEnabled(YAMLWriteFeature f)
     
    protected Object
    readResolve()
    Method that we need to override to actually make restoration go through constructors etc.
    YAMLFactoryBuilder
    rebuild()
     
    tools.jackson.core.TokenStreamFactory
    snapshot()
    Instances are immutable so just return `this`
    tools.jackson.core.Version
    version()
     

    Methods inherited from class tools.jackson.core.base.TextualTSFactory

    _createContentReference, _createContentReference, canHandleBinaryNatively, createGenerator, createGenerator, createGenerator, createGenerator, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser

    Methods inherited from class tools.jackson.core.base.DecorableTSFactory

    _copy, _decorate, _decorate, _decorate, _decorate, _decorate, _decorate, getGeneratorDecorators, getInputDecorator, getOutputDecorator

    Methods inherited from class tools.jackson.core.TokenStreamFactory

    _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _createContext, _createContext, _createDataOutputWrapper, _fileInputStream, _fileOutputStream, _getBufferRecycler, _getRecyclerPool, _optimizedStreamFromURL, _pathInputStream, _pathOutputStream, _reportRangeError, _unsupported, _unsupported, _wrapIOFailure, constructCINameMatcher, constructNameMatcher, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createNonBlockingByteBufferParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, errorReportConfiguration, getFactoryFeatures, getStreamReadFeatures, getStreamWriteFeatures, isEnabled, isEnabled, isEnabled, requiresPropertyOrdering, streamReadConstraints, streamWriteConstraints

    Methods inherited from class java.lang.Object

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

  • Field Details

    • FORMAT_NAME_YAML

      public static final String FORMAT_NAME_YAML
      Name used to identify YAML format. (and returned by getFormatName()
      See Also:

    • DEFAULT_YAML_PARSER_FEATURE_FLAGS

      protected static final int DEFAULT_YAML_PARSER_FEATURE_FLAGS
      Bitfield (set of flags) of all generator 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.

    • _version

      protected final org.snakeyaml.engine.v2.common.SpecVersion _version
      YAML version for underlying generator to follow, if specified.

    • _quotingChecker

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

    • _loadSettings

      protected final org.snakeyaml.engine.v2.api.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).

    • _dumpSettings

      protected final org.snakeyaml.engine.v2.api.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

  • Constructor Details

    • YAMLFactory

      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

      public YAMLFactory(YAMLFactory src)

    • YAMLFactory

      protected YAMLFactory(YAMLFactoryBuilder b)
      Constructors used by YAMLFactoryBuilder for instantiation.
      Since:
      3.0

  • Method Details

    • rebuild

      public YAMLFactoryBuilder rebuild()
      Specified by:
      rebuild in class tools.jackson.core.TokenStreamFactory

    • builder

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

    • copy

      public YAMLFactory copy()
      Specified by:
      copy in class tools.jackson.core.TokenStreamFactory

    • snapshot

      public tools.jackson.core.TokenStreamFactory snapshot()
      Instances are immutable so just return `this`
      Specified by:
      snapshot in interface tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>
      Specified by:
      snapshot in class tools.jackson.core.TokenStreamFactory

    • readResolve

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

    • version

      public tools.jackson.core.Version version()
      Specified by:
      version in interface tools.jackson.core.Versioned
      Specified by:
      version in class tools.jackson.core.TokenStreamFactory

    • canUseCharArrays

      public boolean canUseCharArrays()
      Overrides:
      canUseCharArrays in class tools.jackson.core.base.TextualTSFactory

    • canParseAsync

      public boolean canParseAsync()
      Specified by:
      canParseAsync in class tools.jackson.core.TokenStreamFactory

    • getFormatName

      public String getFormatName()
      Specified by:
      getFormatName in class tools.jackson.core.TokenStreamFactory

    • canUseSchema

      public boolean canUseSchema(tools.jackson.core.FormatSchema schema)
      Specified by:
      canUseSchema in class tools.jackson.core.TokenStreamFactory

    • getFormatReadFeatureType

      public Class<YAMLReadFeature> getFormatReadFeatureType()
      Overrides:
      getFormatReadFeatureType in class tools.jackson.core.TokenStreamFactory

    • getFormatWriteFeatureType

      public Class<YAMLWriteFeature> getFormatWriteFeatureType()
      Overrides:
      getFormatWriteFeatureType in class tools.jackson.core.TokenStreamFactory

    • getFormatReadFeatures

      public int getFormatReadFeatures()
      Overrides:
      getFormatReadFeatures in class tools.jackson.core.TokenStreamFactory

    • getFormatWriteFeatures

      public int getFormatWriteFeatures()
      Overrides:
      getFormatWriteFeatures in class tools.jackson.core.TokenStreamFactory

    • isEnabled

      public boolean isEnabled(YAMLReadFeature f)

    • isEnabled

      public boolean isEnabled(YAMLWriteFeature f)

    • _createParser

      protected YAMLParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, InputStream in)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected YAMLParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, Reader r)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected YAMLParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, char[] data, int offset, int len, boolean recyclable)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected YAMLParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, byte[] data, int offset, int len)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createParser

      protected tools.jackson.core.JsonParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, DataInput input)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _createGenerator

      protected YAMLGenerator _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, Writer out)
      Specified by:
      _createGenerator in class tools.jackson.core.base.TextualTSFactory

    • _createUTF8Generator

      protected YAMLGenerator _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, OutputStream out)
      Specified by:
      _createUTF8Generator in class tools.jackson.core.base.TextualTSFactory

    • _createWriter

      protected Writer _createWriter(tools.jackson.core.io.IOContext ioCtxt, OutputStream out, tools.jackson.core.JsonEncoding enc)
      Overrides:
      _createWriter in class tools.jackson.core.base.TextualTSFactory

    • _createReader

      protected Reader _createReader(InputStream in, tools.jackson.core.JsonEncoding enc, tools.jackson.core.io.IOContext ctxt)

    • _createReader

      protected Reader _createReader(byte[] data, int offset, int len, tools.jackson.core.JsonEncoding enc, tools.jackson.core.io.IOContext ctxt)