Class MapTraversalStep<DataType>

  • All Implemented Interfaces:
    TraversalStep<java.util.Map<java.lang.String,​java.lang.Object>,​DataType>

    public class MapTraversalStep<DataType>
    extends BaseTraversalStep<java.util.Map<java.lang.String,​java.lang.Object>,​DataType>
    TraversalStep that expects to handle Map objects.
    • Method Summary

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

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getStepType

        public java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> map,
                                      java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> map,
                                         java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> map,
                                               java.lang.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