MarshallingConfig (JavaDocs for mmm-all 1.0.0-SNAPSHOT)

java.lang.Object
- io.github.mmm.base.config.ConfigMap
- - io.github.mmm.marshall.MarshallingConfig

public final class MarshallingConfig
extends ConfigMap

ConfigMap for marshalling.

Since:: 1.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static MarshallingConfig`	`DEFAULTS`	Immutable instance of `MarshallingConfig` with the default values.
`static ConfigOption<String>`	`INDENTATION`	`ConfigOption` for the indentation used by `StructuredWriter` to format the output.
`static ConfigOption<Boolean>`	`WRITE_NULL_VALUES`	`ConfigOption` to configure if `StructuredWriter.writeValueAsNull()` should actually write `null` values (if configured to `Boolean.TRUE`) or omit `null` values (if configured to `Boolean.FALSE`).

Constructor Summary

Constructors
Constructor Description

MarshallingConfig()
The constructor.

MarshallingConfig(Map<String,Object> map)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

<T> MarshallingConfig with(ConfigOption<T> option, T value)
- Methods inherited from class io.github.mmm.base.config.ConfigMap
  get, getMap, set, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - INDENTATION
```
public static final ConfigOption<String> INDENTATION
```
    ConfigOption for the indentation used by StructuredWriter to format the output.
  - WRITE_NULL_VALUES
```
public static final ConfigOption<Boolean> WRITE_NULL_VALUES
```
    ConfigOption to configure if StructuredWriter.writeValueAsNull() should actually write null values (if configured to Boolean.TRUE) or omit null values (if configured to Boolean.FALSE).
  - DEFAULTS
```
public static final MarshallingConfig DEFAULTS
```
    Immutable instance of MarshallingConfig with the default values.
- Constructor Detail
  - MarshallingConfig
```
public MarshallingConfig()
```
    The constructor.
  - MarshallingConfig
```
public MarshallingConfig(Map<String,Object> map)
```
    The constructor.
    
    Parameters:
    
    map - the raw Map with the configuration values.
- Method Detail
  - with
```
public <T> MarshallingConfig with(ConfigOption<T> option,
                                  T value)
```
    Type Parameters:
    
    T - type of the value.
    
    Parameters:
    
    option - the ConfigOption to set.
    
    value - the value for the given ConfigOption.
    
    Returns:
    
    a new MarshallingConfig with the given ConfigOption set to the given value or this MarshallingConfig if the given value is already configured.