com.bazaarvoice.jolt.traversr.traversal

Class MapTraversalStep<DataType>

java.lang.Object

com.bazaarvoice.jolt.traversr.traversal.BaseTraversalStep<Map<String,Object>,DataType>

com.bazaarvoice.jolt.traversr.traversal.MapTraversalStep<DataType>

All Implemented Interfaces:

TraversalStep<Map<String,Object>,DataType>

public class MapTraversalStep<DataType>
extends BaseTraversalStep<Map<String,Object>,DataType>

TraversalStep that expects to handle Map objects.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bazaarvoice.jolt.traversr.traversal.TraversalStep

TraversalStep.Operation

Field Summary

Fields inherited from class com.bazaarvoice.jolt.traversr.traversal.BaseTraversalStep

child, traversr

Constructor Summary

Constructors

Constructor and Description
MapTraversalStep(Traversr traversr, TraversalStep child)

Method Summary

Modifier and Type	Method and Description
Optional<DataType>	get(Map<String,Object> map, String key) Return the data for the key from the provided tree object.
Class<?>	getStepType() Return the Class of the Generic T, so that it can be used in an "instanceof" style check.
Map<String,Object>	newContainer() Create a new mutable Map or List, suitable for this PathElement to traverse.
Optional<DataType>	overwriteSet(Map<String,Object> map, String key, DataType data) Insert the data into the tree, overwriting any data that is there.
Optional<DataType>	remove(Map<String,Object> map, String key) Remove and return the data for the key from the provided tree object.

Methods inherited from class com.bazaarvoice.jolt.traversr.traversal.BaseTraversalStep

getChild, traverse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapTraversalStep

public MapTraversalStep(Traversr traversr,
                        TraversalStep child)

Method Detail

getStepType

public Class<?> getStepType()

Description copied from interface: TraversalStep

Return the Class of the Generic T, so that it can be used in an "instanceof" style check.

Returns:

Class that matches Generic parameter T

newContainer

public Map<String,Object> newContainer()

Description copied from interface: TraversalStep

Create a new mutable Map or List, suitable for this PathElement to traverse.

Returns:

new List or Map, depending on the type of the Traversal

get

public Optional<DataType> get(Map<String,Object> map,
                              String key)

Description copied from interface: TraversalStep

Return the data for the key from the provided tree object.

Returns:

data object if available, or null.

remove

public Optional<DataType> remove(Map<String,Object> map,
                                 String key)

Description copied from interface: TraversalStep

Remove and return the data for the key from the provided tree object.

Returns:

data object if available, or null.

overwriteSet

public Optional<DataType> overwriteSet(Map<String,Object> map,
                                       String key,
                                       DataType data)

Description copied from interface: TraversalStep

Insert the data into the tree, overwriting any data that is there.

Returns:

returns the data object if successful or null if it could not