Module tools.jackson.dataformat.properties
Package tools.jackson.dataformat.javaprop

Class JavaPropsFactory

java.lang.Object
tools.jackson.core.TokenStreamFactory
tools.jackson.core.base.DecorableTSFactory
tools.jackson.core.base.TextualTSFactory
tools.jackson.dataformat.javaprop.JavaPropsFactory
All Implemented Interfaces:
Serializable, tools.jackson.core.util.Snapshottable<tools.jackson.core.TokenStreamFactory>, tools.jackson.core.Versioned
public class JavaPropsFactory 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 static final String
    CHARSET_ID_LATIN1
     
    (package private) static final JavaPropsSchema
    EMPTY_SCHEMA
     
    static final String
    FORMAT_NAME_JAVA_PROPERTIES
     
    private static final long
    serialVersionUID
     

    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
     
    JavaPropsFactory()
     
    protected
    JavaPropsFactory(JavaPropsFactory src)
     
    protected
    JavaPropsFactory(JavaPropsFactoryBuilder b)
    Constructors used by JavaPropsFactoryBuilder for instantiation.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected tools.jackson.core.JsonGenerator
    _createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, Writer out)
     
    protected tools.jackson.core.JsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, byte[] data, int offset, int len)
     
    protected tools.jackson.core.JsonParser
    _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 ctxt, DataInput input)
     
    protected tools.jackson.core.JsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, InputStream in)
     
    protected tools.jackson.core.JsonParser
    _createParser(tools.jackson.core.ObjectReadContext readCtxt, tools.jackson.core.io.IOContext ioCtxt, Reader r)
     
    protected tools.jackson.core.JsonGenerator
    _createUTF8Generator(tools.jackson.core.ObjectWriteContext writeCtxt, tools.jackson.core.io.IOContext ioCtxt, OutputStream out)
     
    protected Writer
    _createWriter(tools.jackson.core.io.IOContext ctioCtxtxt, OutputStream out, tools.jackson.core.JsonEncoding enc)
     
    private final JavaPropsSchema
    _getSchema(tools.jackson.core.ObjectReadContext readCtxt)
     
    private final JavaPropsSchema
    _getSchema(tools.jackson.core.ObjectWriteContext ctxt)
     
    protected Properties
    _loadProperties(InputStream in, tools.jackson.core.io.IOContext ctxt)
     
    protected Properties
    _loadProperties(Reader r0, tools.jackson.core.io.IOContext ctxt)
     
    protected <T> T
    _reportReadException(String msg, Exception rootCause)
     
    static JavaPropsFactoryBuilder
    builder()
    Main factory method to use for constructing JavaPropsFactory instances with different configuration.
    boolean
    canParseAsync()
     
    boolean
    canUseCharArrays()
     
    boolean
    canUseSchema(tools.jackson.core.FormatSchema schema)
     
    JavaPropsFactory
    copy()
     
    JavaPropsGenerator
    createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, JavaPropsSchema schema, Map<?,?> target)
    Convenience method to allow using a pre-constructed Map instance as output target, so that serialized property values are added.
    JavaPropsParser
    createParser(tools.jackson.core.ObjectReadContext readCtxt, JavaPropsSchema schema, Map<?,?> content)
    Convenience method to allow feeding a pre-parsed Properties (or, generally Map) instance as input.
    String
    getFormatName()
     
    int
    getFormatReadFeatures()
     
    Class<? extends tools.jackson.core.FormatFeature>
    getFormatReadFeatureType()
     
    int
    getFormatWriteFeatures()
     
    Class<? extends tools.jackson.core.FormatFeature>
    getFormatWriteFeatureType()
     
    JavaPropsFactoryBuilder
    rebuild()
     
    boolean
    requiresPropertyOrdering()
     
    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, streamReadConstraints, streamWriteConstraints

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • rebuild

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

    • builder

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

    • copy

      public JavaPropsFactory 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

    • 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

    • requiresPropertyOrdering

      public boolean requiresPropertyOrdering()
      Overrides:
      requiresPropertyOrdering 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<? extends tools.jackson.core.FormatFeature> getFormatReadFeatureType()
      Overrides:
      getFormatReadFeatureType in class tools.jackson.core.TokenStreamFactory

    • getFormatWriteFeatureType

      public Class<? extends tools.jackson.core.FormatFeature> 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

    • createParser

      public JavaPropsParser createParser(tools.jackson.core.ObjectReadContext readCtxt, JavaPropsSchema schema, Map<?,?> content)
      Convenience method to allow feeding a pre-parsed Properties (or, generally Map) instance as input.

    • createGenerator

      public JavaPropsGenerator createGenerator(tools.jackson.core.ObjectWriteContext writeCtxt, JavaPropsSchema schema, Map<?,?> target)
      Convenience method to allow using a pre-constructed Map instance as output target, so that serialized property values are added.

    • _createParser

      protected tools.jackson.core.JsonParser _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 tools.jackson.core.JsonParser _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 tools.jackson.core.JsonParser _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 tools.jackson.core.JsonParser _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 ctxt, DataInput input)
      Specified by:
      _createParser in class tools.jackson.core.base.TextualTSFactory

    • _getSchema

      private final JavaPropsSchema _getSchema(tools.jackson.core.ObjectReadContext readCtxt)

    • _createGenerator

      protected tools.jackson.core.JsonGenerator _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 tools.jackson.core.JsonGenerator _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 ctioCtxtxt, OutputStream out, tools.jackson.core.JsonEncoding enc)
      Overrides:
      _createWriter in class tools.jackson.core.base.TextualTSFactory

    • _getSchema

      private final JavaPropsSchema _getSchema(tools.jackson.core.ObjectWriteContext ctxt)

    • _loadProperties

      protected Properties _loadProperties(InputStream in, tools.jackson.core.io.IOContext ctxt)

    • _loadProperties

      protected Properties _loadProperties(Reader r0, tools.jackson.core.io.IOContext ctxt)

    • _reportReadException

      protected <T> T _reportReadException(String msg, Exception rootCause)