Package org.redisson.api

Interface RJsonBucket<V>

Type Parameters:
V - the type of object
All Superinterfaces:
RBucket<V>, RBucketAsync<V>, RExpirable, RExpirableAsync, RJsonBucketAsync<V>, RObject, RObjectAsync
All Known Implementing Classes:
RedissonJsonBucket
public interface RJsonBucket<V> extends RBucket<V>, RJsonBucketAsync<V>
Redis JSON datatype holder. Data is stored as JSON object in Redis
Author:
Nikita Koksharov

  • Method Details

    • get

      <T> T get(JsonCodec codec, String... paths)
      Get Json object/objects by JSONPath
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      paths - JSON paths
      Returns:
      object

    • setIfAbsent

      boolean setIfAbsent(String path, Object value)
      Sets Json object by JSONPath only if previous value is empty
      Parameters:
      path - JSON path
      value - object
      Returns:
      true if successful, or false if value was already set

    • trySet

      @Deprecated boolean trySet(String path, Object value)
      Deprecated.
      Use setIfAbsent(String, Object) instead
      Parameters:
      path - JSON path
      value - object
      Returns:
      true if successful, or false if value was already set

    • setIfExists

      boolean setIfExists(String path, Object value)
      Sets Json object by JSONPath only if previous value is non-empty
      Parameters:
      path - JSON path
      value - object
      Returns:
      true if successful, or false if element wasn't set

    • compareAndSet

      boolean compareAndSet(String path, Object expect, Object update)
      Atomically sets the value to the given updated value by given JSONPath, only if serialized state of the current value equals to serialized state of the expected value.
      Parameters:
      path - JSON path
      expect - the expected value
      update - the new value
      Returns:
      true if successful; or false if the actual value was not equal to the expected value.

    • getAndSet

      <T> T getAndSet(JsonCodec codec, String path, Object newValue)
      Retrieves current value of element specified by JSONPath and replaces it with newValue.
      Parameters:
      codec - object codec
      path - JSON path
      newValue - value to set
      Returns:
      previous value

    • set

      void set(String path, Object value)
      Stores object into element by specified JSONPath.
      Parameters:
      path - JSON path
      value - value to set

    • stringSize

      Long stringSize(String path)
      Returns size of string data by JSONPath
      Parameters:
      path - JSON path
      Returns:
      size of string

    • stringSizeMulti

      List<Long> stringSizeMulti(String path)
      Returns list of string data size by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      Returns:
      list of string data sizes

    • stringAppend

      long stringAppend(String path, Object value)
      Appends string data to element specified by JSONPath. Returns new size of string data.
      Parameters:
      path - JSON path
      value - data
      Returns:
      size of string data

    • stringAppendMulti

      List<Long> stringAppendMulti(String path, Object value)
      Appends string data to elements specified by JSONPath. Returns new size of string data. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      value - data
      Returns:
      list of string data sizes

    • arrayAppend

      long arrayAppend(String path, Object... values)
      Appends values to array specified by JSONPath. Returns new size of array.
      Parameters:
      path - JSON path
      values - values to append
      Returns:
      size of array

    • arrayAppendMulti

      List<Long> arrayAppendMulti(String path, Object... values)
      Appends values to arrays specified by JSONPath. Returns new size of arrays. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      values - values to append
      Returns:
      list of arrays size

    • arrayIndex

      long arrayIndex(String path, Object value)
      Returns index of object in array specified by JSONPath. -1 means object not found.
      Parameters:
      path - JSON path
      value - value to search
      Returns:
      index in array

    • arrayIndexMulti

      List<Long> arrayIndexMulti(String path, Object value)
      Returns index of object in arrays specified by JSONPath. -1 means object not found. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      value - value to search
      Returns:
      list of index in arrays

    • arrayIndex

      long arrayIndex(String path, Object value, long start, long end)
      Returns index of object in array specified by JSONPath in range between start (inclusive) and end (exclusive) indexes. -1 means object not found.
      Parameters:
      path - JSON path
      value - value to search
      start - start index, inclusive
      end - end index, exclusive
      Returns:
      index in array

    • arrayIndexMulti

      List<Long> arrayIndexMulti(String path, Object value, long start, long end)
      Returns index of object in arrays specified by JSONPath in range between start (inclusive) and end (exclusive) indexes. -1 means object not found. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      value - value to search
      start - start index, inclusive
      end - end index, exclusive
      Returns:
      list of index in arrays

    • arrayInsert

      long arrayInsert(String path, long index, Object... values)
      Inserts values into array specified by JSONPath. Values are inserted at defined index.
      Parameters:
      path - JSON path
      index - array index at which values are inserted
      values - values to insert
      Returns:
      size of array

    • arrayInsertMulti

      List<Long> arrayInsertMulti(String path, long index, Object... values)
      Inserts values into arrays specified by JSONPath. Values are inserted at defined index. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      index - array index at which values are inserted
      values - values to insert
      Returns:
      list of arrays size

    • arraySize

      long arraySize(String path)
      Returns size of array specified by JSONPath.
      Parameters:
      path - JSON path
      Returns:
      size of array

    • arraySizeMulti

      List<Long> arraySizeMulti(String path)
      Returns size of arrays specified by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      Returns:
      list of arrays size

    • arrayPollLast

      <T> T arrayPollLast(JsonCodec codec, String path)
      Polls last element of array specified by JSONPath.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      Returns:
      last element

    • arrayPollLastMulti

      <T> List<T> arrayPollLastMulti(JsonCodec codec, String path)
      Polls last element of arrays specified by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      Returns:
      list of last elements

    • arrayPollFirst

      <T> T arrayPollFirst(JsonCodec codec, String path)
      Polls first element of array specified by JSONPath.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      Returns:
      first element

    • arrayPollFirstMulti

      <T> List<T> arrayPollFirstMulti(JsonCodec codec, String path)
      Polls first element of arrays specified by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      Returns:
      list of first elements

    • arrayPop

      <T> T arrayPop(JsonCodec codec, String path, long index)
      Pops element located at index of array specified by JSONPath.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      index - array index
      Returns:
      element

    • arrayPopMulti

      <T> List<T> arrayPopMulti(JsonCodec codec, String path, long index)
      Pops elements located at index of arrays specified by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Type Parameters:
      T - the type of object
      Parameters:
      codec - object codec
      path - JSON path
      index - array index
      Returns:
      list of elements

    • arrayTrim

      long arrayTrim(String path, long start, long end)
      Trims array specified by JSONPath in range between start (inclusive) and end (inclusive) indexes.
      Parameters:
      path - JSON path
      start - start index, inclusive
      end - end index, inclusive
      Returns:
      length of array

    • arrayTrimMulti

      List<Long> arrayTrimMulti(String path, long start, long end)
      Trims arrays specified by JSONPath in range between start (inclusive) and end (inclusive) indexes. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      start - start index, inclusive
      end - end index, inclusive
      Returns:
      length of array

    • clear

      long clear()
      Clears json container.
      Returns:
      number of cleared containers

    • clear

      long clear(String path)
      Clears json container specified by JSONPath. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      Returns:
      number of cleared containers

    • incrementAndGet

      <T extends Number> T incrementAndGet(String path, T delta)
      Increments the current value specified by JSONPath by delta.
      Parameters:
      path - JSON path
      delta - increment value
      Returns:
      the updated value

    • incrementAndGetMulti

      <T extends Number> List<T> incrementAndGetMulti(String path, T delta)
      Increments the current values specified by JSONPath by delta. Compatible only with enhanced syntax starting with '$' character.
      Parameters:
      path - JSON path
      delta - increment value
      Returns:
      list of updated value

    • merge

      void merge(String path, Object value)
      Merges object into element by the specified JSONPath.
      Parameters:
      path - JSON path
      value - value to merge

    • countKeys

      long countKeys()
      Returns keys amount in JSON container
      Returns:
      keys amount

    • countKeys

      long countKeys(String path)
      Returns keys amount in JSON container specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      keys amount

    • countKeysMulti

      List<Long> countKeysMulti(String path)
      Returns list of keys amount in JSON containers specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      list of keys amount

    • getKeys

      List<String> getKeys()
      Returns list of keys in JSON container
      Returns:
      list of keys

    • getKeys

      List<String> getKeys(String path)
      Returns list of keys in JSON container specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      list of keys

    • getKeysMulti

      List<List<String>> getKeysMulti(String path)
      Returns list of keys in JSON containers specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      list of keys

    • toggle

      boolean toggle(String path)
      Toggle boolean value specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      new boolean value

    • toggleMulti

      List<Boolean> toggleMulti(String path)
      Toggle boolean values specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      list of boolean values

    • getType

      JsonType getType()
      Returns type of element
      Returns:
      type of element

    • getType

      JsonType getType(String path)
      Returns type of element specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      type of element

    • delete

      long delete(String path)
      Deletes JSON elements specified by JSONPath
      Parameters:
      path - JSON path
      Returns:
      number of deleted elements