DataSource (embulk-api 0.10.31 API)

All Known Subinterfaces:

ConfigDiff, ConfigSource, TaskReport, TaskSource
```
public interface DataSource
```
Base interface of ConfigSource, ConfigDiff, TaskSource, and TaskReport.
It had two following methods that return Jackson's instances till v0.9, but they are removed so that Jackson on the core side can be hidden from plugins.
- Iterable<Map.Entry<String, JsonNode>> getAttributes()
- ObjectNode getObjectNode()
Since:

0.4.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DataSource`	`deepCopy()` Creates a deep copy of itself.
`<E> E`	`get(Class<E> type, String attrName)` Returns an attribute value of `attrName` as `type`.
`<E> E`	`get(Class<E> type, String attrName, E defaultValue)` Returns an attribute value of `attrName` as `type`.
`List<String>`	`getAttributeNames()` Returns a `List` of attribute names under this node.
`DataSource`	`getNested(String attrName)` Returns a nested value under `attrName`.
`DataSource`	`getNestedOrGetEmpty(String attrName)` Returns a nested value under `attrName`.
`DataSource`	`getNestedOrSetEmpty(String attrName)` Returns a nested value under `attrName`.
`boolean`	`has(String attrName)` Returns `true` if it has an attribute named `attrName`.
`boolean`	`isEmpty()` Returns `true` if it is empty.
`DataSource`	`merge(DataSource other)` Merges another `DataSource` into itself.
`DataSource`	`remove(String attrName)` Removes the attribute named `attrName`.
`DataSource`	`set(String attrName, Object v)` Sets a value for `attrName`.
`DataSource`	`setAll(DataSource other)` Sets all attributes in `other` into itself.
`DataSource`	`setNested(String attrName, DataSource v)` Sets a nested value for `attrName`.
`default String`	`toJson()` Returns a JSON representation of itself.

- Method Detail
  - getAttributeNames
```
List<String> getAttributeNames()
```
    Returns a List of attribute names under this node.
    
    Returns:
    
    a List of attribute names
    
    Since:
    
    0.4.0
  - isEmpty
```
boolean isEmpty()
```
    Returns true if it is empty.
    
    Returns:
    
    true if it is empty
    
    Since:
    
    0.4.0
  - has
```
boolean has(String attrName)
```
    Returns true if it has an attribute named attrName.
    
    Parameters:
    
    attrName - name of the attribute to look for
    
    Returns:
    
    true if it has an attribute named attrName
    
    Since:
    
    0.6.21
  - get
```
<E> E get(Class<E> type,
          String attrName)
```
    Returns an attribute value of attrName as type.
    
    Type Parameters:
    
    E - the class to get the value as
    
    Parameters:
    
    type - the class to get the value as
    
    attrName - name of the attribute to look for
    
    Returns:
    
    the attribute value of attrName as type
    
    Since:
    
    0.4.0
  - get
```
<E> E get(Class<E> type,
          String attrName,
          E defaultValue)
```
    Returns an attribute value of attrName as type.
    
    Type Parameters:
    
    E - the class to get the value as
    
    Parameters:
    
    type - the class to get the value as
    
    attrName - name of the attribute to look for
    
    defaultValue - the default value in case a value does not exist for attrName
    
    Returns:
    
    the attribute value of attrName as type
    
    Since:
    
    0.4.0
  - getNested
```
DataSource getNested(String attrName)
```
    Returns a nested value under attrName.
    
    Parameters:
    
    attrName - name of the nested attribute to look for
    
    Returns:
    
    the nested attribute value of attrName
    
    Since:
    
    0.4.0
  - getNestedOrSetEmpty
```
DataSource getNestedOrSetEmpty(String attrName)
```
    Returns a nested value under attrName. Sets an empty object node "{}" there if it is empty.
    
    Parameters:
    
    attrName - name of the nested attribute to look for
    
    Returns:
    
    the nested attribute value of attrName
    
    Since:
    
    0.4.0
  - getNestedOrGetEmpty
```
DataSource getNestedOrGetEmpty(String attrName)
```
    Returns a nested value under attrName. Returns an empty object node "{}" there if it is empty.
    
    Parameters:
    
    attrName - name of the nested attribute to look for
    
    Returns:
    
    the nested attribute value of attrName
    
    Since:
    
    0.7.5
  - set
```
DataSource set(String attrName,
               Object v)
```
    Sets a value for attrName.
    
    Parameters:
    
    attrName - name of the attribute to set the value at
    
    v - the value Object to set
    
    Returns:
    
    itself after the value is set
    
    Since:
    
    0.4.0
  - setNested
```
DataSource setNested(String attrName,
                     DataSource v)
```
    Sets a nested value for attrName.
    
    Parameters:
    
    attrName - name of the attribute to set the nested value at
    
    v - the nested value to set
    
    Returns:
    
    itself after the nested value is set
    
    Since:
    
    0.4.0
  - setAll
```
DataSource setAll(DataSource other)
```
    Sets all attributes in other into itself.
    
    Parameters:
    
    other - the other DataSource to set
    
    Returns:
    
    itself after the attributes are set
    
    Since:
    
    0.4.0
  - remove
```
DataSource remove(String attrName)
```
    Removes the attribute named attrName.
    
    Parameters:
    
    attrName - name of the attribute to remove
    
    Returns:
    
    itself after the attribute is removed
    
    Since:
    
    0.6.14
  - deepCopy
```
DataSource deepCopy()
```
    Creates a deep copy of itself.
    
    Returns:
    
    the new DataSource instance that is deep-copied from itself
    
    Since:
    
    0.4.0
  - merge
```
DataSource merge(DataSource other)
```
    Merges another DataSource into itself.
    
    Parameters:
    
    other - the other DataSource to merge
    
    Returns:
    
    itself after the other DataSource is merged
    
    Since:
    
    0.4.0
  - toJson
```
default String toJson()
```
    Returns a JSON representation of itself.
    
    Returns:
    
    its JSON representation in String
    
    Since:
    
    0.10.3

Interface DataSource

Method Summary

Method Detail

getAttributeNames

isEmpty

has

get

get

getNested

getNestedOrSetEmpty

getNestedOrGetEmpty

set

setNested

setAll

remove

deepCopy

merge

toJson