io.vertx.redis.client.impl.types

Class MultiType

java.lang.Object

io.vertx.redis.client.impl.types.MultiType

All Implemented Interfaces:

Multi, Response, Iterable<Response>

public final class MultiType
extends Object
implements Multi

A Redis MULTI response can represent a List/Set/Map type.

Field Summary

Fields

Modifier and Type	Field and Description
static MultiType	EMPTY_MAP
static MultiType	EMPTY_MULTI

Method Summary

Modifier and Type	Method and Description
void	add(Response reply) Adds a reply to the current response as it gets parsed from the wire.
boolean	complete() Signals that we received all required replies.
boolean	containsKey(String key) Does this multi response contains a string key.
static MultiType	create(long length, boolean asMap)
Response	get(int index) Get this multi response value at a numerical index.
Response	get(String key) Get this multi response value at a string key.
Set<String>	getKeys() Get this multi response keys from a hash.
Iterator<Response>	iterator() Return an iterator so it can be iterated using the foreach construct.
int	size() Get this size of this multi response.
String	toString() Get this response as a String.
ResponseType	type() The response return type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.redis.client.Response

attributes, stream, toBigInteger, toBoolean, toBuffer, toByte, toBytes, toDouble, toFloat, toInteger, toLong, toNumber, toShort, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_MULTI

public static final MultiType EMPTY_MULTI

EMPTY_MAP

public static final MultiType EMPTY_MAP

Method Detail

create

public static MultiType create(long length,
                               boolean asMap)

type

public ResponseType type()

Description copied from interface: Response

The response return type.

Specified by:

type in interface Response

Returns:

the type.

add

public void add(Response reply)

Description copied from interface: Multi

Adds a reply to the current response as it gets parsed from the wire.

Specified by:

add in interface Multi

Parameters:

reply - the reply to add

complete

public boolean complete()

Description copied from interface: Multi

Signals that we received all required replies.

Specified by:

complete in interface Multi

get

public Response get(int index)

Description copied from interface: Response

Get this multi response value at a numerical index.

Specified by:

get in interface Response

Parameters:

index - the required index.

Returns:

Response value.

get

public Response get(String key)

Description copied from interface: Response

Get this multi response value at a string key. Note that REDIS does not support strings as keys but by convention it encodes hashes in lists where index i is the key, and index i+1 is the value.

Specified by:

get in interface Response

Parameters:

key - the required key.

Returns:

Response value.

containsKey

public boolean containsKey(String key)

Description copied from interface: Response

Does this multi response contains a string key. Note that REDIS does not support strings as keys but by convention it encodes hashes in lists where index i is the key, and index i+1 is the value.

Specified by:

containsKey in interface Response

Parameters:

key - the required key.

Returns:

Response value.

getKeys

public Set<String> getKeys()

Description copied from interface: Response

Get this multi response keys from a hash. Note that REDIS does not support strings as keys but by convention it encodes hashes in lists where index i is the key, and index i+1 is the value.

Specified by:

getKeys in interface Response

Returns:

the set of keys.

size

public int size()

Description copied from interface: Response

Get this size of this multi response.

Specified by:

size in interface Response

Returns:

the size of the multi.

toString

public String toString()

Description copied from interface: Response

Get this response as a String.

Specified by:

toString in interface Response

Overrides:

toString in class Object

Returns:

string value

iterator

public Iterator<Response> iterator()

Description copied from interface: Response

Return an iterator so it can be iterated using the foreach construct.

Specified by:

iterator in interface Response

Specified by:

iterator in interface Iterable<Response>

Returns:

response iterator.