org.redisson.api.RBitSetAsync Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Show all versions of redisson-all Show documentation
Redis based In-Memory Data Grid for Java
/**
* Copyright (c) 2013-2021 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 java.util.BitSet;
/**
* Vector of bits that grows as needed. Asynchronous interface.
*
* @author Nikita Koksharov
*
*/
public interface RBitSetAsync extends RExpirableAsync {
/**
* Returns signed number at specified
* offset and size
*
* @param size - size of signed number up to 64 bits
* @param offset - offset of signed number
* @return signed number
*/
RFuture getSignedAsync(int size, long offset);
/**
* Returns previous value of signed number and replaces it
* with defined value at specified offset
*
* @param size - size of signed number up to 64 bits
* @param offset - offset of signed number
* @param value - value of signed number
* @return previous value of signed number
*/
RFuture setSignedAsync(int size, long offset, long value);
/**
* Increments current signed value by
* defined increment value and size
* at specified offset
* and returns result.
*
* @param size - size of signed number up to 64 bits
* @param offset - offset of signed number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetSignedAsync(int size, long offset, long increment);
/**
* Returns unsigned number at specified
* offset and size
*
* @param size - size of unsigned number up to 63 bits
* @param offset - offset of unsigned number
* @return unsigned number
*/
RFuture getUnsignedAsync(int size, long offset);
/**
* Returns previous value of unsigned number and replaces it
* with defined value at specified offset
*
* @param size - size of unsigned number up to 63 bits
* @param offset - offset of unsigned number
* @param value - value of unsigned number
* @return previous value of unsigned number
*/
RFuture setUnsignedAsync(int size, long offset, long value);
/**
* Increments current unsigned value by
* defined increment value and size
* at specified offset
* and returns result.
*
* @param size - size of unsigned number up to 63 bits
* @param offset - offset of unsigned number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetUnsignedAsync(int size, long offset, long increment);
/**
* Returns byte number at specified offset
*
* @param offset - offset of number
* @return number
*/
RFuture getByteAsync(long offset);
/**
* Returns previous value of byte number and replaces it
* with defined value at specified offset
*
* @param offset - offset of number
* @param value - value of number
* @return previous value of number
*/
RFuture setByteAsync(long offset, byte value);
/**
* Increments current byte value on defined increment value at specified offset
* and returns result.
*
* @param offset - offset of number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetByteAsync(long offset, byte increment);
/**
* Returns short number at specified offset
*
* @param offset - offset of number
* @return number
*/
RFuture getShortAsync(long offset);
/**
* Returns previous value of short number and replaces it
* with defined value at specified offset
*
* @param offset - offset of number
* @param value - value of number
* @return previous value of number
*/
RFuture setShortAsync(long offset, short value);
/**
* Increments current short value on defined increment value at specified offset
* and returns result.
*
* @param offset - offset of number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetShortAsync(long offset, short increment);
/**
* Returns integer number at specified offset
*
* @param offset - offset of number
* @return number
*/
RFuture getIntegerAsync(long offset);
/**
* Returns previous value of integer number and replaces it
* with defined value at specified offset
*
* @param offset - offset of number
* @param value - value of number
* @return previous value of number
*/
RFuture setIntegerAsync(long offset, int value);
/**
* Increments current integer value on defined increment value at specified offset
* and returns result.
*
* @param offset - offset of number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetIntegerAsync(long offset, int increment);
/**
* Returns long number at specified offset
*
* @param offset - offset of number
* @return number
*/
RFuture getLongAsync(long offset);
/**
* Returns previous value of long number and replaces it
* with defined value at specified offset
*
* @param offset - offset of number
* @param value - value of number
* @return previous value of number
*/
RFuture setLongAsync(long offset, long value);
/**
* Increments current long value on defined increment value at specified offset
* and returns result.
*
* @param offset - offset of number
* @param increment - increment value
* @return result value
*/
RFuture incrementAndGetLongAsync(long offset, long increment);
RFuture toByteArrayAsync();
/**
* Returns "logical size" = index of highest set bit plus one.
* Returns zero if there are no any set bit.
*
* @return "logical size" = index of highest set bit plus one
*/
RFuture lengthAsync();
/**
* Set all bits to value from fromIndex (inclusive) to toIndex (exclusive)
*
* @param fromIndex inclusive
* @param toIndex exclusive
* @param value true = 1, false = 0
* @return void
*
*/
RFuture setAsync(long fromIndex, long toIndex, boolean value);
/**
* Set all bits to zero from fromIndex (inclusive) to toIndex (exclusive)
*
* @param fromIndex inclusive
* @param toIndex exclusive
* @return void
*
*/
RFuture clearAsync(long fromIndex, long toIndex);
/**
* Copy bits state of source BitSet object to this object
*
* @param bs - BitSet source
* @return void
*/
RFuture setAsync(BitSet bs);
/**
* Executes NOT operation over all bits
*
* @return void
*/
RFuture notAsync();
/**
* Set all bits to one from fromIndex (inclusive) to toIndex (exclusive)
*
* @param fromIndex inclusive
* @param toIndex exclusive
* @return void
*/
RFuture setAsync(long fromIndex, long toIndex);
/**
* Returns number of set bits.
*
* @return number of set bits.
*/
RFuture sizeAsync();
/**
* Returns true if bit set to one and false overwise.
*
* @param bitIndex - index of bit
* @return true if bit set to one and false overwise.
*/
RFuture getAsync(long bitIndex);
/**
* Set bit to one at specified bitIndex
*
* @param bitIndex - index of bit
* @return true - if previous value was true,
* false - if previous value was false
*/
RFuture setAsync(long bitIndex);
/**
* Set bit to value at specified bitIndex
*
* @param bitIndex - index of bit
* @param value true = 1, false = 0
* @return true - if previous value was true,
* false - if previous value was false
*/
RFuture setAsync(long bitIndex, boolean value);
/**
* Returns the number of bits set to one.
*
* @return number of bits
*/
RFuture cardinalityAsync();
/**
* Set bit to zero at specified bitIndex
*
* @param bitIndex - index of bit
* @return true - if previous value was true,
* false - if previous value was false
*/
RFuture clearAsync(long bitIndex);
/**
* Set all bits to zero
*
* @return void
*/
RFuture clearAsync();
/**
* Executes OR operation over this object and specified bitsets.
* Stores result into this object.
*
* @param bitSetNames - name of stored bitsets
* @return void
*/
RFuture orAsync(String... bitSetNames);
/**
* Executes AND operation over this object and specified bitsets.
* Stores result into this object.
*
* @param bitSetNames - name of stored bitsets
* @return void
*/
RFuture andAsync(String... bitSetNames);
/**
* Executes XOR operation over this object and specified bitsets.
* Stores result into this object.
*
* @param bitSetNames - name of stored bitsets
* @return void
*/
RFuture xorAsync(String... bitSetNames);
}