Class JavaPropsMapper

java.lang.Object
com.fasterxml.jackson.core.TreeCodec
com.fasterxml.jackson.core.ObjectCodec
com.fasterxml.jackson.databind.ObjectMapper
com.fasterxml.jackson.dataformat.javaprop.JavaPropsMapper
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned, Serializable
public class JavaPropsMapper extends com.fasterxml.jackson.databind.ObjectMapper
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    JavaPropsMapper.Builder
    Base implementation for "Vanilla" ObjectMapper, used with Java Properties backend.

    Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.ObjectMapper

    com.fasterxml.jackson.databind.ObjectMapper.DefaultTypeResolverBuilder, com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final long
    serialVersionUID
     

    Fields inherited from class com.fasterxml.jackson.databind.ObjectMapper

    _coercionConfigs, _configOverrides, _deserializationConfig, _deserializationContext, _injectableValues, _jsonFactory, _mixIns, _registeredModuleTypes, _rootDeserializers, _serializationConfig, _serializerFactory, _serializerProvider, _subtypeResolver, _typeFactory, DEFAULT_ANNOTATION_INTROSPECTOR, DEFAULT_BASE

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    JavaPropsMapper()
     
     
    JavaPropsMapper(JavaPropsFactory f)
     
    protected
    JavaPropsMapper(JavaPropsMapper src)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Properties
    _env()
     
    static JavaPropsMapper.Builder
    builder()
     
    static JavaPropsMapper.Builder
    builder(JavaPropsFactory streamFactory)
     
    JavaPropsMapper
    copy()
     
    JavaPropsFactory
    getFactory()
     
    <T> T
    readEnvVariablesAs(JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readEnvVariablesAs(JavaPropsSchema schema, Class<T> valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readMapAs(Map<String,String> map, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readMapAs(Map<String,String> map, JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.
    <T> T
    readMapAs(Map<String,String> map, JavaPropsSchema schema, Class<T> valueType)
    Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.
    <T> T
    readMapAs(Map<String,String> map, Class<T> valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readPropertiesAs(Properties props, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readPropertiesAs(Properties props, JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.
    <T> T
    readPropertiesAs(Properties props, JavaPropsSchema schema, Class<T> valueType)
    Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.
    <T> T
    readPropertiesAs(Properties props, Class<T> valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readSystemPropertiesAs(JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType)
    Convenience method, functionally equivalent to:
    <T> T
    readSystemPropertiesAs(JavaPropsSchema schema, Class<T> valueType)
    Convenience method, functionally equivalent to:
    com.fasterxml.jackson.core.Version
    version()
     
    void
    writeValue(Map<?,?> target, Object value)
    Convenience method that "writes" given `value` as properties in given Map object.
    void
    writeValue(Map<?,?> target, Object value, JavaPropsSchema schema)
    Convenience method that "writes" given `value` as properties in given Map object.
    void
    writeValue(Properties targetProps, Object value)
    Deprecated.
    void
    writeValue(Properties targetProps, Object value, JavaPropsSchema schema)
    Deprecated.
    Map<String,String>
    writeValueAsMap(Object value)
    Convenience method that serializes given value but so that results are stored in a newly constructed Properties.
    Map<String,String>
    writeValueAsMap(Object value, JavaPropsSchema schema)
    Convenience method that serializes given value but so that results are stored in given Properties instance.
    Properties
    writeValueAsProperties(Object value)
    Convenience method that serializes given value but so that results are stored in a newly constructed Properties.
    Properties
    writeValueAsProperties(Object value, JavaPropsSchema schema)
    Convenience method that serializes given value but so that results are stored in given Properties instance.

    Methods inherited from class com.fasterxml.jackson.databind.ObjectMapper

    _assertNotNull, _checkInvalidCopy, _configAndWriteValue, _constructDefaultTypeResolverBuilder, _convert, _findRootDeserializer, _initForReading, _newReader, _newReader, _newWriter, _newWriter, _newWriter, _readMapAndClose, _readTreeAndClose, _readValue, _serializerProvider, _verifyNoTrailingTokens, _verifySchemaType, _writeValueAndClose, acceptJsonFormatVisitor, acceptJsonFormatVisitor, activateDefaultTyping, activateDefaultTyping, activateDefaultTyping, activateDefaultTypingAsProperty, addHandler, addMixIn, addMixInAnnotations, canDeserialize, canDeserialize, canSerialize, canSerialize, clearProblemHandlers, coercionConfigDefaults, coercionConfigFor, coercionConfigFor, configOverride, configure, configure, configure, configure, configure, configure, constructType, constructType, convertValue, convertValue, convertValue, copyWith, createArrayNode, createDeserializationContext, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createObjectNode, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, deactivateDefaultTyping, defaultClassIntrospector, disable, disable, disable, disable, disable, disable, disable, disableDefaultTyping, enable, enable, enable, enable, enable, enable, enable, enableDefaultTyping, enableDefaultTyping, enableDefaultTyping, enableDefaultTypingAsProperty, findAndRegisterModules, findMixInClassFor, findModules, findModules, generateJsonSchema, getDateFormat, getDeserializationConfig, getDeserializationContext, getInjectableValues, getNodeFactory, getPolymorphicTypeValidator, getPropertyNamingStrategy, getRegisteredModuleIds, getSerializationConfig, getSerializerFactory, getSerializerProvider, getSerializerProviderInstance, getSubtypeResolver, getTypeFactory, getVisibilityChecker, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, missingNode, mixInCount, nullNode, reader, reader, reader, reader, reader, reader, reader, reader, reader, reader, reader, readerFor, readerFor, readerFor, readerForArrayOf, readerForListOf, readerForMapOf, readerForUpdating, readerWithView, readTree, readTree, readTree, readTree, readTree, readTree, readTree, readTree, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValues, readValues, readValues, readValues, registerModule, registerModules, registerModules, registerSubtypes, registerSubtypes, registerSubtypes, setAccessorNaming, setAnnotationIntrospector, setAnnotationIntrospectors, setBase64Variant, setCacheProvider, setConfig, setConfig, setConstructorDetector, setDateFormat, setDefaultAttributes, setDefaultLeniency, setDefaultMergeable, setDefaultPrettyPrinter, setDefaultPropertyInclusion, setDefaultPropertyInclusion, setDefaultSetterInfo, setDefaultTyping, setDefaultVisibility, setFilterProvider, setFilters, setHandlerInstantiator, setInjectableValues, setLocale, setMixInAnnotations, setMixInResolver, setMixIns, setNodeFactory, setPolymorphicTypeValidator, setPropertyInclusion, setPropertyNamingStrategy, setSerializationInclusion, setSerializerFactory, setSerializerProvider, setSubtypeResolver, setTimeZone, setTypeFactory, setVisibility, setVisibility, setVisibilityChecker, tokenStreamFactory, treeAsTokens, treeToValue, treeToValue, treeToValue, updateValue, valueToTree, writer, writer, writer, writer, writer, writer, writer, writer, writer, writer, writerFor, writerFor, writerFor, writerWithDefaultPrettyPrinter, writerWithType, writerWithType, writerWithType, writerWithView, writeTree, writeTree, writeValue, writeValue, writeValue, writeValue, writeValue, writeValueAsBytes, writeValueAsString

    Methods inherited from class com.fasterxml.jackson.core.ObjectCodec

    getJsonFactory

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • JavaPropsMapper

      public JavaPropsMapper()

    • JavaPropsMapper

      public JavaPropsMapper(JavaPropsFactory f)

    • JavaPropsMapper

      protected JavaPropsMapper(JavaPropsMapper src)

  • Method Details

    • builder

      public static JavaPropsMapper.Builder builder()

    • builder

      public static JavaPropsMapper.Builder builder(JavaPropsFactory streamFactory)

    • copy

      public JavaPropsMapper copy()
      Overrides:
      copy in class com.fasterxml.jackson.databind.ObjectMapper

    • version

      public com.fasterxml.jackson.core.Version version()
      Specified by:
      version in interface com.fasterxml.jackson.core.Versioned
      Overrides:
      version in class com.fasterxml.jackson.databind.ObjectMapper

    • getFactory

      public JavaPropsFactory getFactory()
      Overrides:
      getFactory in class com.fasterxml.jackson.databind.ObjectMapper

    • readPropertiesAs

      public <T> T readPropertiesAs(Properties props, JavaPropsSchema schema, Class<T> valueType) throws IOException
      Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.

      Note that this is NOT identical to calling ObjectMapper.convertValue(Object, Class); rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents.

      Throws:
      IOException
      Since:
      2.9

    • readPropertiesAs

      public <T> T readPropertiesAs(Properties props, JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.

      Note that this is NOT identical to calling ObjectMapper.convertValue(Object, Class); rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents.

      Throws:
      IOException
      Since:
      2.9

    • readPropertiesAs

      public <T> T readPropertiesAs(Properties props, Class<T> valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
      Throws:
      IOException
      Since:
      2.9

    • readPropertiesAs

      public <T> T readPropertiesAs(Properties props, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
      Throws:
      IOException
      Since:
      2.9

    • readMapAs

      public <T> T readMapAs(Map<String,String> map, JavaPropsSchema schema, Class<T> valueType) throws IOException
      Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.

      Note that this is NOT identical to calling ObjectMapper.convertValue(Object, Class); rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents.

      Throws:
      IOException
      Since:
      2.10

    • readMapAs

      public <T> T readMapAs(Map<String,String> map, JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method which uses given `Properties` as the source as if they had been read from an external source, processes them (splits paths etc), and then binds as given result value.

      Note that this is NOT identical to calling ObjectMapper.convertValue(Object, Class); rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents.

      Throws:
      IOException
      Since:
      2.10

    • readMapAs

      public <T> T readMapAs(Map<String,String> map, Class<T> valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
      Throws:
      IOException
      Since:
      2.10

    • readMapAs

      public <T> T readMapAs(Map<String,String> map, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
      Throws:
      IOException
      Since:
      2.10

    • readSystemPropertiesAs

      public <T> T readSystemPropertiesAs(JavaPropsSchema schema, Class<T> valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(System.getProperties(), schema, valueType);
      Throws:
      IOException
      Since:
      2.9

    • readSystemPropertiesAs

      public <T> T readSystemPropertiesAs(JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(System.getProperties(), schema, valueType);
      Throws:
      IOException
      Since:
      2.9

    • readEnvVariablesAs

      public <T> T readEnvVariablesAs(JavaPropsSchema schema, Class<T> valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);
      Throws:
      IOException
      Since:
      2.9

    • readEnvVariablesAs

      public <T> T readEnvVariablesAs(JavaPropsSchema schema, com.fasterxml.jackson.databind.JavaType valueType) throws IOException
      Convenience method, functionally equivalent to: 
         readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);
      Throws:
      IOException
      Since:
      2.9

    • _env

      protected Properties _env()

    • writeValue

      public void writeValue(Map<?,?> target, Object value) throws IOException
      Convenience method that "writes" given `value` as properties in given Map object.
      Throws:
      IOException
      Since:
      2.10

    • writeValue

      public void writeValue(Map<?,?> target, Object value, JavaPropsSchema schema) throws IOException
      Convenience method that "writes" given `value` as properties in given Map object.
      Throws:
      IOException
      Since:
      2.10

    • writeValue

      @Deprecated public void writeValue(Properties targetProps, Object value) throws IOException
      Deprecated.
      Throws:
      IOException

    • writeValue

      @Deprecated public void writeValue(Properties targetProps, Object value, JavaPropsSchema schema) throws IOException
      Deprecated.
      Throws:
      IOException

    • writeValueAsProperties

      public Properties writeValueAsProperties(Object value) throws IOException
      Convenience method that serializes given value but so that results are stored in a newly constructed Properties. Functionally equivalent to serializing in a File and reading contents into Properties.
      Throws:
      IOException
      Since:
      2.9

    • writeValueAsProperties

      public Properties writeValueAsProperties(Object value, JavaPropsSchema schema) throws IOException
      Convenience method that serializes given value but so that results are stored in given Properties instance.
      Throws:
      IOException
      Since:
      2.9

    • writeValueAsMap

      public Map<String,String> writeValueAsMap(Object value) throws IOException
      Convenience method that serializes given value but so that results are stored in a newly constructed Properties. Functionally equivalent to serializing in a File and reading contents into Properties.
      Throws:
      IOException
      Since:
      2.10

    • writeValueAsMap

      public Map<String,String> writeValueAsMap(Object value, JavaPropsSchema schema) throws IOException
      Convenience method that serializes given value but so that results are stored in given Properties instance.
      Throws:
      IOException
      Since:
      2.10