org.redisson.api.RJsonBucket Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson Show documentation
Show all versions of redisson Show documentation
Redis Java client with features of In-Memory Data Grid
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.redisson.api;
import org.redisson.codec.JsonCodec;
import java.util.List;
/**
* Redis JSON datatype holder. Data is stored as JSON object in Redis
*
* @author Nikita Koksharov
* @param the type of object
*/
public interface RJsonBucket extends RBucket, RJsonBucketAsync {
/**
* Get Json object/objects by JSONPath
*
* @param codec object codec
* @param paths JSON paths
* @return object
*
* @param the type of object
*/
T get(JsonCodec codec, String... paths);
/**
* Sets Json object by JSONPath only if previous value is empty
*
* @param path JSON path
* @param value object
* @return {@code true} if successful, or {@code false} if
* value was already set
*/
boolean setIfAbsent(String path, Object value);
/**
* Use {@link #setIfAbsent(String, Object)} instead
*
* @param path JSON path
* @param value object
* @return {@code true} if successful, or {@code false} if
* value was already set
*/
@Deprecated
boolean trySet(String path, Object value);
/**
* Sets Json object by JSONPath only if previous value is non-empty
*
* @param path JSON path
* @param value object
* @return {@code true} if successful, or {@code false} if
* element wasn't set
*/
boolean setIfExists(String path, Object value);
/**
* 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.
*
* @param path JSON path
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful; or {@code false} if the actual value
* was not equal to the expected value.
*/
boolean compareAndSet(String path, Object expect, Object update);
/**
* Retrieves current value of element specified by JSONPath
* and replaces it with newValue.
*
* @param codec object codec
* @param path JSON path
* @param newValue value to set
* @return previous value
*/
T getAndSet(JsonCodec codec, String path, Object newValue);
/**
* Stores object into element by specified JSONPath.
*
* @param path JSON path
* @param value value to set
*/
void set(String path, Object value);
/**
* Returns size of string data by JSONPath
*
* @param path JSON path
* @return size of string
*/
Long stringSize(String path);
/**
* Returns list of string data size by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @return list of string data sizes
*/
List stringSizeMulti(String path);
/**
* Appends string data to element specified by JSONPath.
* Returns new size of string data.
*
* @param path JSON path
* @param value data
* @return size of string data
*/
long stringAppend(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.
*
* @param path JSON path
* @param value data
* @return list of string data sizes
*/
List stringAppendMulti(String path, Object value);
/**
* Appends values to array specified by JSONPath.
* Returns new size of array.
*
* @param path JSON path
* @param values values to append
* @return size of array
*/
long arrayAppend(String path, Object... values);
/**
* Appends values to arrays specified by JSONPath.
* Returns new size of arrays.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @param values values to append
* @return list of arrays size
*/
List arrayAppendMulti(String path, Object... values);
/**
* Returns index of object in array specified by JSONPath.
* -1 means object not found.
*
* @param path JSON path
* @param value value to search
* @return index in array
*/
long arrayIndex(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.
*
* @param path JSON path
* @param value value to search
* @return list of index in arrays
*/
List arrayIndexMulti(String path, Object value);
/**
* Returns index of object in array specified by JSONPath
* in range between start (inclusive) and end (exclusive) indexes.
* -1 means object not found.
*
* @param path JSON path
* @param value value to search
* @param start start index, inclusive
* @param end end index, exclusive
* @return index in array
*/
long arrayIndex(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.
*
* @param path JSON path
* @param value value to search
* @param start start index, inclusive
* @param end end index, exclusive
* @return list of index in arrays
*/
List arrayIndexMulti(String path, Object value, long start, long end);
/**
* Inserts values into array specified by JSONPath.
* Values are inserted at defined index.
*
* @param path JSON path
* @param index array index at which values are inserted
* @param values values to insert
* @return size of array
*/
long arrayInsert(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.
*
* @param path JSON path
* @param index array index at which values are inserted
* @param values values to insert
* @return list of arrays size
*/
List arrayInsertMulti(String path, long index, Object... values);
/**
* Returns size of array specified by JSONPath.
*
* @param path JSON path
* @return size of array
*/
long arraySize(String path);
/**
* Returns size of arrays specified by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @return list of arrays size
*/
List arraySizeMulti(String path);
/**
* Polls last element of array specified by JSONPath.
*
* @param codec object codec
* @param path JSON path
* @return last element
*
* @param the type of object
*/
T arrayPollLast(JsonCodec codec, String path);
/**
* Polls last element of arrays specified by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param codec object codec
* @param path JSON path
* @return list of last elements
*
* @param the type of object
*/
List arrayPollLastMulti(JsonCodec codec, String path);
/**
* Polls first element of array specified by JSONPath.
*
* @param codec object codec
* @param path JSON path
* @return first element
*
* @param the type of object
*/
T arrayPollFirst(JsonCodec codec, String path);
/**
* Polls first element of arrays specified by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param codec object codec
* @param path JSON path
* @return list of first elements
*
* @param the type of object
*/
List arrayPollFirstMulti(JsonCodec codec, String path);
/**
* Pops element located at index of array specified by JSONPath.
*
* @param codec object codec
* @param path JSON path
* @param index array index
* @return element
*
* @param the type of object
*/
T arrayPop(JsonCodec codec, String path, long index);
/**
* Pops elements located at index of arrays specified by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param codec object codec
* @param path JSON path
* @param index array index
* @return list of elements
*
* @param the type of object
*/
List arrayPopMulti(JsonCodec codec, String path, long index);
/**
* Trims array specified by JSONPath in range
* between start (inclusive) and end (inclusive) indexes.
*
* @param path JSON path
* @param start start index, inclusive
* @param end end index, inclusive
* @return length of array
*/
long arrayTrim(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.
*
* @param path JSON path
* @param start start index, inclusive
* @param end end index, inclusive
* @return length of array
*/
List arrayTrimMulti(String path, long start, long end);
/**
* Clears json container.
*
* @return number of cleared containers
*/
long clear();
/**
* Clears json container specified by JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @return number of cleared containers
*/
long clear(String path);
/**
* Increments the current value specified by JSONPath by delta.
*
* @param path JSON path
* @param delta increment value
* @return the updated value
*/
T incrementAndGet(String path, T delta);
/**
* Increments the current values specified by JSONPath by delta.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @param delta increment value
* @return list of updated value
*/
List incrementAndGetMulti(String path, T delta);
/**
* Merges object into element by the specified JSONPath.
*
* @param path JSON path
* @param value value to merge
*/
void merge(String path, Object value);
/**
* Returns keys amount in JSON container
*
* @return keys amount
*/
long countKeys();
/**
* Returns keys amount in JSON container specified by JSONPath
*
* @param path JSON path
* @return keys amount
*/
long countKeys(String path);
/**
* Returns list of keys amount in JSON containers specified by JSONPath
*
* @param path JSON path
* @return list of keys amount
*/
List countKeysMulti(String path);
/**
* Returns list of keys in JSON container
*
* @return list of keys
*/
List getKeys();
/**
* Returns list of keys in JSON container specified by JSONPath
*
* @param path JSON path
* @return list of keys
*/
List getKeys(String path);
/**
* Returns list of keys in JSON containers specified by JSONPath
*
* @param path JSON path
* @return list of keys
*/
List> getKeysMulti(String path);
/**
* Toggle boolean value specified by JSONPath
*
* @param path JSON path
* @return new boolean value
*/
boolean toggle(String path);
/**
* Toggle boolean values specified by JSONPath
*
* @param path JSON path
* @return list of boolean values
*/
List toggleMulti(String path);
/**
* Returns type of element
*
* @return type of element
*/
JsonType getType();
/**
* Returns type of element specified by JSONPath
*
* @param path JSON path
* @return type of element
*/
JsonType getType(String path);
/**
* Deletes JSON elements specified by JSONPath
*
* @param path JSON path
* @return number of deleted elements
*/
long delete(String path);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy