Class JsonPointerIterator

java.lang.Object
io.vertx.mutiny.core.json.pointer.JsonPointerIterator
All Implemented Interfaces:
MutinyDelegate

public class JsonPointerIterator extends Object implements MutinyDelegate
The JsonPointerIterator is used by the read/write algorithms of the JsonPointer to read/write the querying data structure
Every method takes the currentValue as parameter, representing the actual value held by the query algorithm.
Implementations of this interface should be stateless, so they can be reused
You can implement this interface to query the structure you want using json pointers

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Francesco Guardiani @slinkydeveloper
See Also:
  • JsonPointerIterator
  • Field Details

  • Constructor Details

    • JsonPointerIterator

      public JsonPointerIterator(io.vertx.core.json.pointer.JsonPointerIterator delegate)
      Create a new instance of JsonPointerIterator delegating to the given (non-null) instance of JsonPointerIterator.
    • JsonPointerIterator

      public JsonPointerIterator(Object delegate)
  • Method Details

    • getDelegate

      public io.vertx.core.json.pointer.JsonPointerIterator getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance
    • isObject

      public boolean isObject(Object currentValue)
      Parameters:
      currentValue - . Can be null.
      Returns:
      true if the current value is a queryable object
    • isArray

      public boolean isArray(Object currentValue)
      Parameters:
      currentValue - . Can be null.
      Returns:
      true if the current value is a queryable array
    • isNull

      public boolean isNull(Object currentValue)
      Parameters:
      currentValue - . Can be null.
      Returns:
      true if the current value is null/empty
    • objectContainsKey

      public boolean objectContainsKey(Object currentValue, String key)
      Parameters:
      currentValue - . Can be null.
      key - object key
      Returns:
      true if current value is a queryable object that contains the specified key
    • getObjectParameter

      public Object getObjectParameter(Object currentValue, String key, boolean createOnMissing)
      Returns the object parameter with specified key.
      Parameters:
      currentValue - . Can be null.
      key - object key
      createOnMissing - If the current value is an object that doesn't contain the key, put an empty object at provided key
      Returns:
      the requested object parameter, or null if the method was not able to find it
    • getArrayElement

      public Object getArrayElement(Object currentValue, int i)
      Move the iterator the array element at specified index
      Parameters:
      currentValue - . Can be null.
      i - array index
      Returns:
      the request array element, or null if the method was not able to find it
    • writeObjectParameter

      public boolean writeObjectParameter(Object currentValue, String key, Object value)
      Write object parameter at specified key
      Parameters:
      currentValue - . Can be null.
      key -
      value - . Can be null.
      Returns:
      true if the operation is successful
    • writeArrayElement

      public boolean writeArrayElement(Object currentValue, int i, Object value)
      Write array element at specified index
      Parameters:
      currentValue - . Can be null.
      i -
      value - . Can be null.
      Returns:
      true if the operation is successful
    • appendArrayElement

      public boolean appendArrayElement(Object currentValue, Object value)
      Append array element
      Parameters:
      currentValue - . Can be null.
      value - . Can be null.
      Returns:
      true if the operation is successful
    • newInstance

      public static JsonPointerIterator newInstance(io.vertx.core.json.pointer.JsonPointerIterator delegate)
      Creates a new instance of the JsonPointerIterator.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object