Jackson 3.0.1 · tools.jackson.dataformat.javaprop.JavaPropsMapper

Modifier and Type	Class and Description
public static class	JavaPropsMapper.Builder Base implementation for "Vanilla" `ObjectMapper`, used with Java Properties backend.
private static class	JavaPropsMapper.SharedWrapper Helper class to contain dynamically constructed "shared" instance of mapper, should one be needed via `shared`.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Access	Constructor and Description
public	JavaPropsMapper()
public	JavaPropsMapper(JavaPropsFactory f)
public	JavaPropsMapper(JavaPropsMapper.Builder b)

Method Summary

Modifier and Type	Method and Description
protected Properties	_env()
public static JavaPropsMapper.Builder	builder()
public static JavaPropsMapper.Builder	builder(JavaPropsFactory streamFactory)
public <T> T	readEnvVariablesAs(JavaPropsSchema schema, Class<T> valueType) Convenience method, functionally equivalent to: readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);
public <T> T	readEnvVariablesAs(JavaPropsSchema schema, JavaType valueType) Convenience method, functionally equivalent to: readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);
public <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.
public <T> T	readMapAs(Map<String, String> map, JavaPropsSchema schema, 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.
public <T> T	readMapAs(Map<String, String> map, Class<T> valueType) Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
public <T> T	readMapAs(Map<String, String> map, JavaType valueType) Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
public <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.
public <T> T	readPropertiesAs(Properties props, JavaPropsSchema schema, 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.
public <T> T	readPropertiesAs(Properties props, Class<T> valueType) Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
public <T> T	readPropertiesAs(Properties props, JavaType valueType) Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);
protected Object	readResolve() Overrides tools.jackson.databind.ObjectMapper.readResolve.
public <T> T	readSystemPropertiesAs(JavaPropsSchema schema, Class<T> valueType) Convenience method, functionally equivalent to: readPropertiesAs(System.getProperties(), schema, valueType);
public <T> T	readSystemPropertiesAs(JavaPropsSchema schema, JavaType valueType) Convenience method, functionally equivalent to: readPropertiesAs(System.getProperties(), schema, valueType);
public JavaPropsMapper.Builder	rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules.
public static JavaPropsMapper	shared() Accessor method for getting globally shared "default" `JavaPropsMapper` instance: one that has default configuration, no modules registered, no config overrides.
public JavaPropsFactory	tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s.
public Version	version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.
protected Object	writeReplace() Overrides tools.jackson.databind.ObjectMapper.writeReplace.
public void	writeValue(Map<?, ?> target, Object value) Convenience method that "writes" given `value` as properties in given `Map` object.
public void	writeValue(Map<?, ?> target, Object value, JavaPropsSchema schema) Convenience method that "writes" given `value` as properties in given `Map` object.
public Map<String, String>	writeValueAsMap(Object value) Convenience method that serializes given value but so that results are stored in a newly constructed `Properties`.
public Map<String, String>	writeValueAsMap(Object value, JavaPropsSchema schema) Convenience method that serializes given value but so that results are stored in given `Properties` instance.
public Properties	writeValueAsProperties(Object value) Convenience method that serializes given value but so that results are stored in a newly constructed `Properties`.
public Properties	writeValueAsProperties(Object value, JavaPropsSchema schema) Convenience method that serializes given value but so that results are stored in given `Properties` instance.

Inherited from tools.jackson.databind.ObjectMapper:: _assertNotNull _configAndWriteValue _convert _deserializationContext _deserializationContext _deserializationContext _findRootDeserializer _initForReading _newReader _newReader _newWriter _newWriter _newWriter _readMapAndClose _readTreeAndClose _readValue _serializationContext _serializationContext _verifyNoTrailingTokens _verifySchemaType _writeCloseableValue acceptJsonFormatVisitor acceptJsonFormatVisitor acceptJsonFormatVisitor booleanNode clearCaches constructType constructType convertValue convertValue convertValue createArrayNode createGenerator createGenerator createGenerator createGenerator createGenerator createGenerator createNonBlockingByteArrayParser createNonBlockingByteBufferParser createObjectNode createParser createParser createParser createParser createParser createParser createParser createParser createParser createParser deserializationConfig getInjectableValues getNodeFactory getTypeFactory isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled missingNode nullNode 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 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 readValue readValue readValue readValue readValues readValues readValues registeredModules serializationConfig stringNode treeAsTokens treeToValue treeToValue treeToValue updateValue valueToTree writer writer writer writer writer writer writer writer writer writer writerFor writerFor writerFor writerWithDefaultPrettyPrinter writerWithView writeTree writeValue writeValue writeValue writeValue writeValue writeValue writeValueAsBytes writeValueAsString writeValueIntoBuffer

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

JavaPropsMapper	back to summary
public JavaPropsMapper()

JavaPropsMapper	back to summary
public JavaPropsMapper(JavaPropsFactory f)

JavaPropsMapper	back to summary
public JavaPropsMapper(JavaPropsMapper.Builder b)

Method Detail

_env	back to summary
protected Properties _env()

builder	back to summary
public static JavaPropsMapper.Builder builder()

builder	back to summary
public static JavaPropsMapper.Builder builder(JavaPropsFactory streamFactory)

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

readEnvVariablesAs

back to summary

public <T> T readEnvVariablesAs(JavaPropsSchema schema, Class<T> valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);

readEnvVariablesAs	back to summary
public <T> T readEnvVariablesAs(JavaPropsSchema schema, JavaType valueType) throws IOException Convenience method, functionally equivalent to: readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);

readEnvVariablesAs

back to summary

public <T> T readEnvVariablesAs(JavaPropsSchema schema, JavaType valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(convertMapToProperties(System.getenv()), schema, valueType);

readMapAs back to summary

readMapAs	back to summary
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 `convertValue(Object, Class)`; rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents. Annotations @SuppressWarnings:resource

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 convertValue(Object, Class); rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents.

Annotations

@SuppressWarnings:resource

readMapAs back to summary

readMapAs	back to summary
public <T> T readMapAs(Map<String, String> map, JavaPropsSchema schema, 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 `convertValue(Object, Class)`; rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents. Annotations @SuppressWarnings:resource, unchecked

public <T> T readMapAs(Map<String, String> map, JavaPropsSchema schema, 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.

Annotations

@SuppressWarnings:resource, unchecked

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

readMapAs

back to summary

public <T> T readMapAs(Map<String, String> map, Class<T> valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readMapAs	back to summary
public <T> T readMapAs(Map<String, String> map, JavaType valueType) throws IOException Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readMapAs

back to summary

public <T> T readMapAs(Map<String, String> map, JavaType valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readPropertiesAs back to summary

readPropertiesAs	back to summary
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 `convertValue(Object, Class)`; rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents. Annotations @SuppressWarnings:resource

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.

Annotations

@SuppressWarnings:resource

readPropertiesAs back to summary

readPropertiesAs	back to summary
public <T> T readPropertiesAs(Properties props, JavaPropsSchema schema, 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 `convertValue(Object, Class)`; rather, it would be similar to writing `Properties` out into a File, then calling `readValue()` on this mapper to bind contents. Annotations @SuppressWarnings:resource, unchecked

public <T> T readPropertiesAs(Properties props, JavaPropsSchema schema, 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.

Annotations

@SuppressWarnings:resource, unchecked

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

readPropertiesAs

back to summary

public <T> T readPropertiesAs(Properties props, Class<T> valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readPropertiesAs	back to summary
public <T> T readPropertiesAs(Properties props, JavaType valueType) throws IOException Convenience method, functionally equivalent to: readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readPropertiesAs

back to summary

public <T> T readPropertiesAs(Properties props, JavaType valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(props, JavaPropsSchema.emptySchema(), valueType);

readResolve	back to summary
protected Object readResolve() Overrides tools.jackson.databind.ObjectMapper.readResolve. Annotations @Override

readResolve

back to summary

protected Object readResolve()

Overrides tools.jackson.databind.ObjectMapper.readResolve.

Annotations

@Override

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

readSystemPropertiesAs

back to summary

public <T> T readSystemPropertiesAs(JavaPropsSchema schema, Class<T> valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(System.getProperties(), schema, valueType);

readSystemPropertiesAs	back to summary
public <T> T readSystemPropertiesAs(JavaPropsSchema schema, JavaType valueType) throws IOException Convenience method, functionally equivalent to: readPropertiesAs(System.getProperties(), schema, valueType);

readSystemPropertiesAs

back to summary

public <T> T readSystemPropertiesAs(JavaPropsSchema schema, JavaType valueType) throws IOException

Convenience method, functionally equivalent to:

   readPropertiesAs(System.getProperties(), schema, valueType);

rebuild back to summary

rebuild	back to summary
public JavaPropsMapper.Builder rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Doc from tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules. Annotations @SuppressWarnings:unchecked @Override

public JavaPropsMapper.Builder rebuild()

Overrides tools.jackson.databind.ObjectMapper.rebuild.

Doc from tools.jackson.databind.ObjectMapper.rebuild.

Method for creating a new MapperBuilder for constructing differently configured ObjectMapper instance, starting with current configuration including base settings and registered modules.

Annotations

@SuppressWarnings:unchecked
@Override

shared	back to summary
public static JavaPropsMapper shared() Accessor method for getting globally shared "default" `JavaPropsMapper` instance: one that has default configuration, no modules registered, no config overrides. Usable mostly when dealing "untyped" or Tree-style content reading and writing.

tokenStreamFactory back to summary

tokenStreamFactory	back to summary
public JavaPropsFactory tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s. Warning note that all `ObjectReader` and `ObjectWriter` instances created by this mapper usually share the same configured `TokenStreamFactory`, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of `ObjectReader` and `ObjectWriter` for changing `StreamReadFeature` and `StreamWriteFeature` settings to use on per-call basis. Annotations @Override

public JavaPropsFactory tokenStreamFactory()

Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Method that can be used to get hold of TokenStreamFactory that this mapper uses if it needs to construct JsonParsers and/or JsonGenerators.

Warning

note that all ObjectReader and ObjectWriter instances created by this mapper usually share the same configured TokenStreamFactory, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of ObjectReader and ObjectWriter for changing StreamReadFeature and StreamWriteFeature settings to use on per-call basis.

Annotations

@Override

version	back to summary
public Version version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.databind.ObjectMapper.version. Method that will return version information stored in and read from jar that contains this class. Annotations @Override

version

back to summary

public Version version()

Overrides tools.jackson.databind.ObjectMapper.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.databind.ObjectMapper.version.

Method that will return version information stored in and read from jar that contains this class.

Annotations

@Override

writeReplace	back to summary
protected Object writeReplace() Overrides tools.jackson.databind.ObjectMapper.writeReplace. Annotations @Override

writeReplace

back to summary

protected Object writeReplace()

Overrides tools.jackson.databind.ObjectMapper.writeReplace.

Annotations

@Override

writeValue	back to summary
public void writeValue(Map<?, ?> target, Object value) throws IOException Convenience method that "writes" given `value` as properties in given `Map` object.

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

writeValueAsMap	back to summary
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`.

writeValueAsMap	back to summary
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.

writeValueAsProperties	back to summary
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`.

writeValueAsProperties	back to summary
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.

public Class JavaPropsMapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class JavaPropsMapper.Builder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class JavaPropsMapper.Builder.StateImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class JavaPropsMapper.SharedWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Access	Constructor and Description
public	Builder(JavaPropsFactory f)
public	Builder(JavaPropsMapper.Builder.StateImpl state)

Modifier and Type	Method and Description
protected MapperBuilderState	_saveState() Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState.
public JavaPropsMapper	build() Implements abstract tools.jackson.databind.cfg.MapperBuilder.build. Method to call to create actual mapper instance.