com.bazaarvoice.jolt.traversr.traversal

Class MapTraversalStep

java.lang.Object

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

com.bazaarvoice.jolt.traversr.traversal.MapTraversalStep

All Implemented Interfaces:

TraversalStep<Map<String,Object>>

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

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

Methods

Modifier and Type	Method and Description
Object	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.
Object	newContainer() Create a new mutable Map or List, suitable for this PathElement to traverse.
Object	overwriteSet(Map<String,Object> map, String key, Object data) Insert the data into the tree, overwriting any data that is there.
Object	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 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 Object 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 Object 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 Object overwriteSet(Map<String,Object> map,
                  String key,
                  Object 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