public class BitFieldArgs extends Object
BitFieldArgs
is a mutable object and instances should be used only once to avoid shared mutable state.Modifier and Type | Class and Description |
---|---|
static class |
BitFieldArgs.BitFieldType
Represents a bit field type with details about signed/unsigned and the number of bits.
|
static class |
BitFieldArgs.Builder
Builder entry points for
BitFieldArgs . |
static class |
BitFieldArgs.Offset
Represents a bit field offset.
|
static class |
BitFieldArgs.OverflowType
Represents the overflow types for the
OVERFLOW subcommand argument. |
Constructor and Description |
---|
BitFieldArgs()
Creates a new
BitFieldArgs instance. |
Modifier and Type | Method and Description |
---|---|
BitFieldArgs |
get()
Adds a new
GET subcommand using offset 0 and the field type of the previous command. |
BitFieldArgs |
get(BitFieldArgs.BitFieldType bitFieldType)
Adds a new
GET subcommand using offset 0 . |
BitFieldArgs |
get(BitFieldArgs.BitFieldType bitFieldType,
BitFieldArgs.Offset offset)
Adds a new
GET subcommand. |
BitFieldArgs |
get(BitFieldArgs.BitFieldType bitFieldType,
int offset)
Adds a new
GET subcommand. |
BitFieldArgs |
get(int offset)
Adds a new
GET subcommand using the field type of the previous command. |
BitFieldArgs |
incrBy(BitFieldArgs.BitFieldType bitFieldType,
BitFieldArgs.Offset offset,
long value)
Adds a new
INCRBY subcommand. |
BitFieldArgs |
incrBy(BitFieldArgs.BitFieldType bitFieldType,
int offset,
long value)
Adds a new
INCRBY subcommand. |
BitFieldArgs |
incrBy(BitFieldArgs.BitFieldType bitFieldType,
long value)
Adds a new
INCRBY subcommand using offset 0 . |
BitFieldArgs |
incrBy(int offset,
long value)
Adds a new
INCRBY subcommand using the field type of the previous command. |
BitFieldArgs |
incrBy(long value)
Adds a new
INCRBY subcommand using offset 0 and the field type of the previous command. |
static BitFieldArgs.Offset |
offset(int offset)
Creates a new
BitFieldArgs.Offset for the given offset . |
BitFieldArgs |
overflow(BitFieldArgs.OverflowType overflowType)
Adds a new
OVERFLOW subcommand. |
BitFieldArgs |
set(BitFieldArgs.BitFieldType bitFieldType,
BitFieldArgs.Offset offset,
long value)
Adds a new
SET subcommand. |
BitFieldArgs |
set(BitFieldArgs.BitFieldType bitFieldType,
int offset,
long value)
Adds a new
SET subcommand. |
BitFieldArgs |
set(BitFieldArgs.BitFieldType bitFieldType,
long value)
Adds a new
SET subcommand using offset 0 . |
BitFieldArgs |
set(int offset,
long value)
Adds a new
SET subcommand using the field type of the previous command. |
BitFieldArgs |
set(long value)
Adds a new
SET subcommand using offset 0 and the field type of the previous command. |
static BitFieldArgs.BitFieldType |
signed(int bits)
Creates a new signed
BitFieldArgs.BitFieldType for the given number of bits . |
static BitFieldArgs.Offset |
typeWidthBasedOffset(int offset)
Creates a new
BitFieldArgs.Offset for the given offset that is multiplied by the integer type width used in the sub
command. |
static BitFieldArgs.BitFieldType |
unsigned(int bits)
Creates a new unsigned
BitFieldArgs.BitFieldType for the given number of bits . |
public BitFieldArgs()
BitFieldArgs
instance.public static BitFieldArgs.BitFieldType signed(int bits)
BitFieldArgs.BitFieldType
for the given number of bits
.
Redis allows up to 64
bits for unsigned integers.bits
- number of bits to define the integer type width.BitFieldArgs.BitFieldType
.public static BitFieldArgs.BitFieldType unsigned(int bits)
BitFieldArgs.BitFieldType
for the given number of bits
. Redis allows up to 63
bits for
unsigned integers.bits
- number of bits to define the integer type width.BitFieldArgs.BitFieldType
.public static BitFieldArgs.Offset offset(int offset)
BitFieldArgs.Offset
for the given offset
.offset
- zero-based offset.BitFieldArgs.Offset
.public static BitFieldArgs.Offset typeWidthBasedOffset(int offset)
BitFieldArgs.Offset
for the given offset
that is multiplied by the integer type width used in the sub
command.offset
- offset to be multiplied by the integer type width.BitFieldArgs.Offset
.public BitFieldArgs get()
GET
subcommand using offset 0
and the field type of the previous command.GET
subcommand for the given bitFieldType
and offset
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs get(BitFieldArgs.BitFieldType bitFieldType)
GET
subcommand using offset 0
.bitFieldType
- the bit field type, must not be null.GET
subcommand for the given bitFieldType
and offset
.public BitFieldArgs get(BitFieldArgs.BitFieldType bitFieldType, int offset)
GET
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offsetGET
subcommand for the given bitFieldType
and offset
.public BitFieldArgs get(BitFieldArgs.BitFieldType bitFieldType, BitFieldArgs.Offset offset)
GET
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offsetGET
subcommand for the given bitFieldType
and offset
.public BitFieldArgs get(int offset)
GET
subcommand using the field type of the previous command.offset
- bitfield offsetGET
subcommand for the given bitFieldType
and offset
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs set(long value)
SET
subcommand using offset 0
and the field type of the previous command.value
- the valueSET
subcommand for the given bitFieldType
, offset
and value
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs set(BitFieldArgs.BitFieldType bitFieldType, long value)
SET
subcommand using offset 0
.bitFieldType
- the bit field type, must not be null.value
- the valueSET
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs set(int offset, long value)
SET
subcommand using the field type of the previous command.offset
- bitfield offsetvalue
- the valueSET
subcommand for the given bitFieldType
, offset
and value
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs set(BitFieldArgs.BitFieldType bitFieldType, int offset, long value)
SET
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offsetvalue
- the valueSET
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs set(BitFieldArgs.BitFieldType bitFieldType, BitFieldArgs.Offset offset, long value)
SET
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offset, must not be null.value
- the valueSET
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs incrBy(long value)
INCRBY
subcommand using offset 0
and the field type of the previous command.value
- the valueINCRBY
subcommand for the given bitFieldType
, offset
and value
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs incrBy(BitFieldArgs.BitFieldType bitFieldType, long value)
INCRBY
subcommand using offset 0
.bitFieldType
- the bit field type, must not be null.value
- the valueINCRBY
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs incrBy(int offset, long value)
INCRBY
subcommand using the field type of the previous command.offset
- bitfield offsetvalue
- the valueINCRBY
subcommand for the given bitFieldType
, offset
and value
.IllegalStateException
- if no previous field type was foundpublic BitFieldArgs incrBy(BitFieldArgs.BitFieldType bitFieldType, int offset, long value)
INCRBY
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offsetvalue
- the valueINCRBY
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs incrBy(BitFieldArgs.BitFieldType bitFieldType, BitFieldArgs.Offset offset, long value)
INCRBY
subcommand.bitFieldType
- the bit field type, must not be null.offset
- bitfield offset, must not be null.value
- the valueINCRBY
subcommand for the given bitFieldType
, offset
and value
.public BitFieldArgs overflow(BitFieldArgs.OverflowType overflowType)
OVERFLOW
subcommand.overflowType
- type of overflow, must not be null.OVERFLOW
subcommand for the given overflowType
.Copyright © 2018 lettuce.io. All rights reserved.