io.vertx.axle.core.shareddata

Class AsyncMap<K,V>

java.lang.Object

io.vertx.axle.core.shareddata.AsyncMap<K,V>

public class AsyncMap<K,V>
extends Object

An asynchronous map.

AsyncMap does not allow null to be used as a key or value.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static TypeArg<AsyncMap>	__TYPE_ARG
TypeArg<K>	__typeArg_0
TypeArg<V>	__typeArg_1

Constructor Summary

Constructors

Constructor and Description
AsyncMap(io.vertx.core.shareddata.AsyncMap delegate)
AsyncMap(io.vertx.core.shareddata.AsyncMap delegate, TypeArg<K> typeArg_0, TypeArg<V> typeArg_1)

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	clear() Clear all entries in the map
boolean	equals(Object o)
CompletionStage<V>	get(K k) Get a value from the map, asynchronously.
io.vertx.core.shareddata.AsyncMap	getDelegate()
int	hashCode()
static <K,V> AsyncMap<K,V>	newInstance(io.vertx.core.shareddata.AsyncMap arg)
static <K,V> AsyncMap<K,V>	newInstance(io.vertx.core.shareddata.AsyncMap arg, TypeArg<K> __typeArg_K, TypeArg<V> __typeArg_V)
CompletionStage<Void>	put(K k, V v) Put a value in the map, asynchronously.
CompletionStage<Void>	put(K k, V v, long ttl) Like put(K, V) but specifying a time to live for the entry.
CompletionStage<V>	putIfAbsent(K k, V v) Put the entry only if there is no entry with the key already present.
CompletionStage<V>	putIfAbsent(K k, V v, long ttl) Link putIfAbsent(K, V) but specifying a time to live for the entry.
CompletionStage<V>	remove(K k) Remove a value from the map, asynchronously.
CompletionStage<Boolean>	removeIfPresent(K k, V v) Remove a value from the map, only if entry already exists with same value.
CompletionStage<V>	replace(K k, V v) Replace the entry only if it is currently mapped to some value
CompletionStage<Boolean>	replaceIfPresent(K k, V oldValue, V newValue) Replace the entry only if it is currently mapped to a specific value
CompletionStage<Integer>	size() Provide the number of entries in the map
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<AsyncMap> __TYPE_ARG

__typeArg_0

public final TypeArg<K> __typeArg_0

__typeArg_1

public final TypeArg<V> __typeArg_1

Constructor Detail

AsyncMap

public AsyncMap(io.vertx.core.shareddata.AsyncMap delegate)

AsyncMap

public AsyncMap(io.vertx.core.shareddata.AsyncMap delegate,
                TypeArg<K> typeArg_0,
                TypeArg<V> typeArg_1)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public io.vertx.core.shareddata.AsyncMap getDelegate()

get

public CompletionStage<V> get(K k)

Get a value from the map, asynchronously.

Parameters:

k - the key

Returns:

put

public CompletionStage<Void> put(K k,
                                 V v)

Put a value in the map, asynchronously.

Parameters:

k - the key

v - the value

Returns:

put

public CompletionStage<Void> put(K k,
                                 V v,
                                 long ttl)

Like put(K, V) but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters:

k - the key

v - the value

ttl - The time to live (in ms) for the entry

Returns:

putIfAbsent

public CompletionStage<V> putIfAbsent(K k,
                                      V v)

Put the entry only if there is no entry with the key already present. If key already present then the existing value will be returned to the handler, otherwise null.

Parameters:

k - the key

v - the value

Returns:

putIfAbsent

public CompletionStage<V> putIfAbsent(K k,
                                      V v,
                                      long ttl)

Link putIfAbsent(K, V) but specifying a time to live for the entry. Entry will expire and get evicted after the ttl.

Parameters:

k - the key

v - the value

ttl - The time to live (in ms) for the entry

Returns:

remove

public CompletionStage<V> remove(K k)

Remove a value from the map, asynchronously.

Parameters:

k - the key

Returns:

removeIfPresent

public CompletionStage<Boolean> removeIfPresent(K k,
                                                V v)

Remove a value from the map, only if entry already exists with same value.

Parameters:

k - the key

v - the value

Returns:

replace

public CompletionStage<V> replace(K k,
                                  V v)

Replace the entry only if it is currently mapped to some value

Parameters:

k - the key

v - the new value

Returns:

replaceIfPresent

public CompletionStage<Boolean> replaceIfPresent(K k,
                                                 V oldValue,
                                                 V newValue)

Replace the entry only if it is currently mapped to a specific value

Parameters:

k - the key

oldValue - the existing value

newValue - the new value

Returns:

clear

public CompletionStage<Void> clear()

Clear all entries in the map

Returns:

size

public CompletionStage<Integer> size()

Provide the number of entries in the map

Returns:

newInstance

public static <K,V> AsyncMap<K,V> newInstance(io.vertx.core.shareddata.AsyncMap arg)

newInstance

public static <K,V> AsyncMap<K,V> newInstance(io.vertx.core.shareddata.AsyncMap arg,
                                              TypeArg<K> __typeArg_K,
                                              TypeArg<V> __typeArg_V)