Package de.undercouch.bson4jackson

Class BsonFactory

java.lang.Object
tools.jackson.core.TokenStreamFactory
tools.jackson.core.base.DecorableTSFactory
tools.jackson.core.base.TextualTSFactory
tools.jackson.core.json.JsonFactory
de.undercouch.bson4jackson.BsonFactory
All Implemented Interfaces:
Serializable, tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>, tools.jackson.core.Versioned
public class BsonFactory extends tools.jackson.core.json.JsonFactory
Factory for BsonGenerator and BsonParser
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 tools.jackson.core.io.CharacterEscapes
    _bsonCharacterEscapes
    Custom character escapes to use for generators created by this factory
    protected int
    _bsonGeneratorFeatures
    The BSON generator features to be enabled when a new generator is created
    protected int
    _bsonParserFeatures
    The BSON parser features to be enabled when a new parser is created
    protected static final int
    DEFAULT_BSON_GENERATOR_FEATURE_FLAGS
    The BSON generator features enabled by default
    protected static final int
    DEFAULT_BSON_PARSER_FEATURE_FLAGS
    The BSON parser features enabled by default

    Fields inherited from class tools.jackson.core.json.JsonFactory

    _byteSymbolCanonicalizer, _characterEscapes, _maximumNonEscapedChar, _quoteChar, _rootCharSymbols, _rootValueSeparator, DEFAULT_QUOTE_CHAR, DEFAULT_ROOT_VALUE_SEPARATOR, FORMAT_NAME_JSON

    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
     
    BsonFactory()
     
    protected
    BsonFactory(BsonFactory src)
    Constructor used when copy()ing a factory instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected BsonGenerator
    _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ctxt, Writer out)
     
    protected BsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, byte[] data, int offset, int len)
     
    protected BsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, InputStream in)
     
    protected BsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, Reader r)
     
    protected BsonGenerator
    _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ctxt, OutputStream out)
     
    final BsonFactory
    configure(BsonGenerator.Feature f, boolean state)
    Method for enabling/disabling specified generator features (check BsonGenerator.Feature for list of features)
    final BsonFactory
    configure(BsonParser.Feature f, boolean state)
    Method for enabling/disabling specified parser features (check BsonParser.Feature for list of features)
    BsonFactory
    copy()
    Returns a new cloned copy of the factory
    BsonFactory
    disable(BsonGenerator.Feature f)
    Method for disabling specified generator features (check BsonGenerator.Feature for list of features)
    BsonFactory
    disable(BsonParser.Feature f)
    Method for disabling specified parser features (check BsonParser.Feature for list of features)
    BsonFactory
    enable(BsonGenerator.Feature f)
    Method for enabling specified generator features (check BsonGenerator.Feature for list of features)
    BsonFactory
    enable(BsonParser.Feature f)
    Method for enabling specified parser features (check BsonParser.Feature for list of features)
    final boolean
    isEnabled(BsonGenerator.Feature f)
    Checks whether a generator feature is enabled
    final boolean
    isEnabled(BsonParser.Feature f)
    Checks whether a parser feature is enabled
    void
    setCharacterEscapes(tools.jackson.core.io.CharacterEscapes esc)
    Sets the character escapes to use for generators created by this factory

    Methods inherited from class tools.jackson.core.json.JsonFactory

    _createNonBlockingContext, _createParser, _createParser, builder, builderWithJackson2Defaults, canParseAsync, canUseSchema, constructCINameMatcher, constructNameMatcher, createNonBlockingByteArrayParser, createNonBlockingByteBufferParser, getCharacterEscapes, getFormatName, getFormatReadFeatureType, getFormatWriteFeatureType, getRootValueSeparator, isEnabled, isEnabled, readResolve, rebuild, snapshot, version

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

    _createContentReference, _createContentReference, _createWriter, canHandleBinaryNatively, canUseCharArrays, 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, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, errorReportConfiguration, getFactoryFeatures, getFormatReadFeatures, getFormatWriteFeatures, 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

    • DEFAULT_BSON_GENERATOR_FEATURE_FLAGS

      protected static final int DEFAULT_BSON_GENERATOR_FEATURE_FLAGS
      The BSON generator features enabled by default
      See Also:

    • DEFAULT_BSON_PARSER_FEATURE_FLAGS

      protected static final int DEFAULT_BSON_PARSER_FEATURE_FLAGS
      The BSON parser features enabled by default
      See Also:

    • _bsonCharacterEscapes

      protected tools.jackson.core.io.CharacterEscapes _bsonCharacterEscapes
      Custom character escapes to use for generators created by this factory

    • _bsonGeneratorFeatures

      protected int _bsonGeneratorFeatures
      The BSON generator features to be enabled when a new generator is created

    • _bsonParserFeatures

      protected int _bsonParserFeatures
      The BSON parser features to be enabled when a new parser is created

  • Constructor Details

    • BsonFactory

      public BsonFactory()
      See Also:
      • JsonFactory()

    • BsonFactory

      protected BsonFactory(BsonFactory src)

      Constructor used when copy()ing a factory instance.

      Parameters:
      src - the source BsonFactory to copy
      Since:
      2.5

  • Method Details

    • copy

      public BsonFactory copy()
      Returns a new cloned copy of the factory
      Overrides:
      copy in class tools.jackson.core.json.JsonFactory
      Returns:
      deep copy of the factory
      Since:
      2.5
      See Also:
      • JsonFactory.copy()

    • configure

      public final BsonFactory configure(BsonGenerator.Feature f, boolean state)
      Method for enabling/disabling specified generator features (check BsonGenerator.Feature for list of features)
      Parameters:
      f - the feature to enable or disable
      state - true if the feature should be enabled, false otherwise
      Returns:
      this BsonFactory

    • enable

      public BsonFactory enable(BsonGenerator.Feature f)
      Method for enabling specified generator features (check BsonGenerator.Feature for list of features)
      Parameters:
      f - the feature to enable
      Returns:
      this BsonFactory

    • disable

      public BsonFactory disable(BsonGenerator.Feature f)
      Method for disabling specified generator features (check BsonGenerator.Feature for list of features)
      Parameters:
      f - the feature to disable
      Returns:
      this BsonFactory

    • isEnabled

      public final boolean isEnabled(BsonGenerator.Feature f)
      Checks whether a generator feature is enabled
      Parameters:
      f - the feature to check for
      Returns:
      true if the specified generator feature is enabled

    • configure

      public final BsonFactory configure(BsonParser.Feature f, boolean state)
      Method for enabling/disabling specified parser features (check BsonParser.Feature for list of features)
      Parameters:
      f - the feature to enable or disable
      state - true if the feature should be enabled, false otherwise
      Returns:
      this BsonFactory

    • enable

      public BsonFactory enable(BsonParser.Feature f)
      Method for enabling specified parser features (check BsonParser.Feature for list of features)
      Parameters:
      f - the feature to enable
      Returns:
      this BsonFactory

    • disable

      public BsonFactory disable(BsonParser.Feature f)
      Method for disabling specified parser features (check BsonParser.Feature for list of features)
      Parameters:
      f - the feature to disable
      Returns:
      this BsonFactory

    • isEnabled

      public final boolean isEnabled(BsonParser.Feature f)
      Checks whether a parser feature is enabled
      Parameters:
      f - the feature to check for
      Returns:
      true if the specified parser feature is enabled

    • setCharacterEscapes

      public void setCharacterEscapes(tools.jackson.core.io.CharacterEscapes esc)
      Sets the character escapes to use for generators created by this factory
      Parameters:
      esc - the character escapes (may be null)

    • _createParser

      protected BsonParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, InputStream in)
      Overrides:
      _createParser in class tools.jackson.core.json.JsonFactory

    • _createParser

      protected BsonParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, byte[] data, int offset, int len)
      Overrides:
      _createParser in class tools.jackson.core.json.JsonFactory

    • _createParser

      protected BsonParser _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ctxt, Reader r)
      Overrides:
      _createParser in class tools.jackson.core.json.JsonFactory

    • _createUTF8Generator

      protected BsonGenerator _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ctxt, OutputStream out)
      Overrides:
      _createUTF8Generator in class tools.jackson.core.json.JsonFactory

    • _createGenerator

      protected BsonGenerator _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ctxt, Writer out)
      Overrides:
      _createGenerator in class tools.jackson.core.json.JsonFactory