net.kuujo.vertigo.cluster.data

Interface AsyncMap<K,V>

Type Parameters:

K - The map key type.

V - The map value type.

All Known Subinterfaces:

WatchableAsyncMap<K,V>

All Known Implementing Classes:

DefaultAsyncMap, WrappedWatchableAsyncMap

public interface AsyncMap<K,V>

Asynchronous map.

If the current Vert.x instance is a Hazelcast clustered instance, the map will be backed by a Hazelcast map. Otherwise, the map will be backed by a Vert.x shared data map.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all keys from the map.
void	clear(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Clears all keys from the map.
void	containsKey(K key, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether the map contains a key.
void	get(K key, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> resultHandler) Gets a key value from the map.
void	isEmpty(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler) Checks whether the map is empty.
void	keySet(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Set<K>>> resultHandler) Gets a set of keys in the map.
String	name() Returns the map name.
void	put(K key, V value) Sets a key value in the map.
void	put(K key, V value, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> doneHandler) Sets a key value in the map.
void	remove(K key) Removes a key from the map.
void	remove(K key, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> resultHandler) Removes a key from the map.
void	size(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Integer>> resultHandler) Gets the current size of the map.
void	values(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<V>>> resultHandler) Gets a collection of values in the map.

Method Detail

name

String name()

Returns the map name.

Returns:

The map name.

put

void put(K key,
       V value)

Sets a key value in the map.

Parameters:

key - The key to set.

value - The value to set.

put

void put(K key,
       V value,
       org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> doneHandler)

Sets a key value in the map.

Parameters:

key - The key to set.

value - The value to set.

doneHandler - An asynchronous handler to be called once complete. The handler will be called with the previous key value if any.

get

void get(K key,
       org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> resultHandler)

Gets a key value from the map.

Parameters:

key - The key to get.

resultHandler - An asynchronous handler to be called with the result. If the key is not set then the result value will be null.

remove

void remove(K key)

Removes a key from the map.

Parameters:

key - The key to remove.

remove

void remove(K key,
          org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<V>> resultHandler)

Removes a key from the map.

Parameters:

key - The key to remove.

resultHandler - An asynchronous handler to be called with the removed value. If the key is not set then the result value will be null.

containsKey

void containsKey(K key,
               org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler)

Checks whether the map contains a key.

Parameters:

key - The key to check.

resultHandler - An asynchronous handler to be called with the result indicating whether the given key exists in the map.

keySet

void keySet(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Set<K>>> resultHandler)

Gets a set of keys in the map.

Parameters:

resultHandler - An asynchronous handler to be called with the key set once complete.

values

void values(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Collection<V>>> resultHandler)

Gets a collection of values in the map.

Parameters:

resultHandler - An asynchronous handler to be called with the values once complete.

size

void size(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Integer>> resultHandler)

Gets the current size of the map.

Parameters:

resultHandler - An asynchronous handler to be called with the result.

isEmpty

void isEmpty(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> resultHandler)

Checks whether the map is empty.

Parameters:

resultHandler - An asynchronous handler to be called with the result indicating whether the map is empty.

clear

void clear()

Clears all keys from the map.

clear

void clear(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Clears all keys from the map.

Parameters:

doneHandler - An asynchronous handler to be called once complete.