Package | Description |
---|---|
com.fasterxml.jackson.dataformat.javaprop |
Basic API types to use with this module:
JavaPropsFactory
is the JsonFactory implementation used to
create Java Properties parsers and generators
JavaPropsGenerator
is the matching JsonGenerator implementation to use
JavaPropsParser
is the matching JsonParser implementation to use
JavaPropsMapper is a convenience
sub-class of ObjectMapper that is both configured
to use JavaPropsFactory , and
adds additional methods for using alternate content sources and targets for improved
interoperability with Properties , System Properties, and env properties
JavaPropsSchema is the
FormatSchema implementation to use with Java Properties
and defines details of how flat Java Properties keys are mapped to structured names
of logical properties, POJOs, as well as other variations within possible Properties
file notation (like indentation, key/value separator, linefeed to use)
|
com.fasterxml.jackson.dataformat.javaprop.util |
Helper classes for dealing with property key to structured path conversion.
|
Modifier and Type | Field and Description |
---|---|
protected JavaPropsSchema |
JavaPropsParser._schema
Schema we use for parsing Properties into structure of some kind.
|
protected JavaPropsSchema |
JavaPropsGenerator._schema
Definition of columns being written, if available.
|
protected static JavaPropsSchema |
JavaPropsParser.DEFAULT_SCHEMA |
protected static JavaPropsSchema |
JavaPropsSchema.EMPTY |
Modifier and Type | Method and Description |
---|---|
static JavaPropsSchema |
JavaPropsSchema.emptySchema() |
JavaPropsSchema |
JavaPropsParser.getSchema() |
JavaPropsSchema |
JavaPropsSchema.withFirstArrayOffset(int v) |
JavaPropsSchema |
JavaPropsSchema.withHeader(String v)
Mutant factory for constructing schema instance where specified
header section (piece of text written out right before actual
properties entries) will be used.
|
JavaPropsSchema |
JavaPropsSchema.withIndexMarker(Markers v) |
JavaPropsSchema |
JavaPropsSchema.withKeyValueSeparator(String v) |
JavaPropsSchema |
JavaPropsSchema.withLineEnding(String v) |
JavaPropsSchema |
JavaPropsSchema.withLineIndentation(String v) |
JavaPropsSchema |
JavaPropsSchema.withoutHeader()
Convenience method, functionally equivalent to:
|
JavaPropsSchema |
JavaPropsSchema.withoutIndexMarker() |
JavaPropsSchema |
JavaPropsSchema.withoutLineIndentation() |
JavaPropsSchema |
JavaPropsSchema.withoutPathSeparator()
Mutant factory method for constructing a new instance that
specifies that no "path splitting" is to be done: this is
similar to default behavior of
Properties
in which keys are full Strings and there is no nesting of values. |
JavaPropsSchema |
JavaPropsSchema.withParseSimpleIndexes(boolean v) |
JavaPropsSchema |
JavaPropsSchema.withPathSeparator(String v)
Mutant factory method for constructing a new instance with
specified path separator; default being comma (".").
|
JavaPropsSchema |
JavaPropsSchema.withWriteIndexUsingMarkers(boolean v) |
Modifier and Type | Method and Description |
---|---|
<T> T |
JavaPropsMapper.readEnvVariablesAs(JavaPropsSchema schema,
Class<T> valueType)
Convenience method, functionally equivalent to:
|
<T> T |
JavaPropsMapper.readEnvVariablesAs(JavaPropsSchema schema,
com.fasterxml.jackson.databind.JavaType valueType)
Convenience method, functionally equivalent to:
|
<T> T |
JavaPropsMapper.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 |
JavaPropsMapper.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 |
JavaPropsMapper.readSystemPropertiesAs(JavaPropsSchema schema,
Class<T> valueType)
Convenience method, functionally equivalent to:
|
<T> T |
JavaPropsMapper.readSystemPropertiesAs(JavaPropsSchema schema,
com.fasterxml.jackson.databind.JavaType valueType)
Convenience method, functionally equivalent to:
|
void |
JavaPropsMapper.writeValue(Properties targetProps,
Object value,
JavaPropsSchema schema)
Convenience method that "writes" given `value` as properties
in given
Properties object. |
Properties |
JavaPropsMapper.writeValueAsProperties(Object value,
JavaPropsSchema schema)
Convenience method that serializes given value but so that results are
stored in given
Properties instance. |
Constructor and Description |
---|
JavaPropsSchema(JavaPropsSchema base) |
Modifier and Type | Method and Description |
---|---|
static JPropNode |
JPropNodeBuilder.build(JavaPropsSchema schema,
Properties props) |
static JPropPathSplitter |
JPropPathSplitter.create(JavaPropsSchema schema) |
Copyright © 2017 FasterXML. All rights reserved.