ConfigMapperFactory (embulk-util-config v0.3.4)

java.lang.Object
- org.embulk.util.config.ConfigMapperFactory

```
public final class ConfigMapperFactory
extends Object
```
Creates ConfigMapper and TaskMapper with required and specified Jackson Modules and Validator.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConfigMapperFactory.Builder
Builds ConfigMapperFactory.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigMapperFactory.Builder` Builds `ConfigMapperFactory`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConfigMapperFactory.Builder`	`builder()` Creates a `ConfigMapperFactory.Builder` to build `ConfigMapperFactory`.
`ConfigMapper`	`createConfigMapper()` Creates a `ConfigMapper` to maps `org.embulk.config.ConfigSource` into a task-defining interface that inherits `Task`.
`TaskMapper`	`createTaskMapper()` Creates a `TaskMapper` to maps `org.embulk.config.TaskSource` into a task-defining interface that inherits `Task`.
`ConfigDiff`	`newConfigDiff()` Creates an empty `ConfigDiff` instance.
`ConfigSource`	`newConfigSource()` Creates an empty `ConfigSource` instance.
`TaskReport`	`newTaskReport()` Creates an empty `TaskReport` instance.
`TaskSource`	`newTaskSource()` Creates an empty `TaskSource` instance.
`ConfigDiff`	`rebuildConfigDiff(ConfigDiff configDiff)` Rebuilds `ConfigDiff` with the context of this `embulk-util-config`.
`TaskReport`	`rebuildTaskReport(TaskReport taskReport)` Rebuilds `TaskReport` with the context of this `embulk-util-config`.
`static ConfigMapperFactory`	`with(Module... modules)` Creates a `ConfigMapperFactory` with required and specified Jackson `Module`s.
`static ConfigMapperFactory`	`with(Validator validator, Module... modules)` Creates a `ConfigMapperFactory` with required and specified Jackson `Module`s and `Validator`.
`static ConfigMapperFactory`	`withDefault()` Creates a `ConfigMapperFactory` with required and default Jackson `Module`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static ConfigMapperFactory.Builder builder()
```
    Creates a ConfigMapperFactory.Builder to build ConfigMapperFactory.
  - with
```
public static ConfigMapperFactory with(Validator validator,
                                       Module... modules)
```
    Creates a ConfigMapperFactory with required and specified Jackson Modules and Validator.
  - with
```
public static ConfigMapperFactory with(Module... modules)
```
    Creates a ConfigMapperFactory with required and specified Jackson Modules.
  - withDefault
```
public static ConfigMapperFactory withDefault()
```
    Creates a ConfigMapperFactory with required and default Jackson Modules.
  - createConfigMapper
```
public ConfigMapper createConfigMapper()
```
    Creates a ConfigMapper to maps org.embulk.config.ConfigSource into a task-defining interface that inherits Task.
  - createTaskMapper
```
public TaskMapper createTaskMapper()
```
    Creates a TaskMapper to maps org.embulk.config.TaskSource into a task-defining interface that inherits Task.
  - newConfigDiff
```
public ConfigDiff newConfigDiff()
```
    Creates an empty ConfigDiff instance.
    It is to replace Exec.newConfigDiff().
  - newConfigSource
```
public ConfigSource newConfigSource()
```
    Creates an empty ConfigSource instance.
    It is to replace Exec.newConfigSource().
  - newTaskReport
```
public TaskReport newTaskReport()
```
    Creates an empty TaskReport instance.
    It is to replace Exec.newTaskReport().
  - newTaskSource
```
public TaskSource newTaskSource()
```
    Creates an empty TaskSource instance.
    It is to replace Exec.newTaskSource().
  - rebuildConfigDiff
```
public ConfigDiff rebuildConfigDiff(ConfigDiff configDiff)
```
    Rebuilds ConfigDiff with the context of this embulk-util-config.
    ConfigDiff passed from embulk-core is built with the context of embulk-core. It is usually fine, but sometimes, it could be problematic because the given ConfigDiff is built with Jackson on the embulk-core side.
    For example, when converting a ConfigDiff instance to a Jackson object, such as JsonNode like below, it fails.
```
  configDiff.get(JsonNode.class, "field");
```
    Rebuilding the given ConfigDiff instance would mitigate such a problem.
    Parameters:
    
    configDiff - a ConfigDiff instance to rebuild
    
    Returns:
    
    the new ConfigDiff instance rebuilt
  - rebuildTaskReport
```
public TaskReport rebuildTaskReport(TaskReport taskReport)
```
    Rebuilds TaskReport with the context of this embulk-util-config.
    TaskReport passed from embulk-core is built with the context of embulk-core. It is usually fine, but sometimes, it could be problematic because the given TaskReport is built with Jackson on the embulk-core side.
    For example, when converting a TaskReport instance to a Jackson object, such as JsonNode like below, it fails.
```
  taskReport.get(JsonNode.class, "field");
```
    Rebuilding the given TaskReport instance would mitigate such a problem.
    Parameters:
    
    taskReport - a TaskReport instance to rebuild
    
    Returns:
    
    the new TaskReport instance rebuilt

Class ConfigMapperFactory

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

with

with

withDefault

createConfigMapper

createTaskMapper

newConfigDiff

newConfigSource

newTaskReport

newTaskSource

rebuildConfigDiff

rebuildTaskReport