net.openhft.chronicle.map

Class ChronicleMapStatelessClientBuilder<K,V>

java.lang.Object

net.openhft.chronicle.map.ChronicleMapStatelessClientBuilder<K,V>

All Implemented Interfaces:

ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>, MapBuilder<ChronicleMapStatelessClientBuilder<K,V>>

public final class ChronicleMapStatelessClientBuilder<K,V>
extends Object
implements ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>, MapBuilder<ChronicleMapStatelessClientBuilder<K,V>>

Author:

Rob Austin.

Method Summary

Methods

Modifier and Type	Method and Description
ChronicleMap<K,V>	create()
static <K,V> ChronicleMap<K,V>	createClientOf(InetSocketAddress serverAddress) Equivalent of ChronicleMapStatelessClientBuilder.<K, V>of(serverAddress).create().
ChronicleMapStatelessClientBuilder<K,V>	name(String name)
ChronicleMapStatelessClientBuilder<K,V>	putReturnsNull(boolean putReturnsNull) Configures if the maps created by this MapBuilder should return null instead of previous mapped values on ChornicleMap.put(key, value) calls.
ChronicleMapStatelessClientBuilder<K,V>	removeReturnsNull(boolean removeReturnsNull) Configures if the maps created by this MapBuilder should return null instead of the last mapped value on ChronicleMap.remove(key) calls.
ChronicleMapStatelessClientBuilder<K,V>	tcpBufferSize(int tcpBufferSize)
ChronicleMapStatelessClientBuilder<K,V>	timeout(long timeout, TimeUnit units)

Methods inherited from class java.lang.Object

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

Method Detail

createClientOf

public static <K,V> ChronicleMap<K,V> createClientOf(InetSocketAddress serverAddress)
                                        throws IOException

Equivalent of ChronicleMapStatelessClientBuilder.<K, V>of(serverAddress).create().

Type Parameters:

K - key type of the map

V - value type of the map

Parameters:

serverAddress - address of the server map

Returns:

stateless client of the ChronicleMap of server

Throws:

IOException

putReturnsNull

public ChronicleMapStatelessClientBuilder<K,V> putReturnsNull(boolean putReturnsNull)

Description copied from interface: MapBuilder

Configures if the maps created by this MapBuilder should return null instead of previous mapped values on ChornicleMap.put(key, value) calls.

Map.put() returns the previous value, functionality which is rarely used but fairly cheap for simple in-process, on-heap implementations like HashMap. But an off-heap collection has to create a new object and deserialize the data from off-heap memory. A collection hiding remote queries over the network should send the value back in addition to that. It's expensive for something you probably don't use.

By default, of cause, ChronicleMap conforms the general Map contract and returns the previous mapped value on put() calls.

Specified by:

putReturnsNull in interface MapBuilder<ChronicleMapStatelessClientBuilder<K,V>>

Parameters:

putReturnsNull - true if you want ChronicleMap.put() to not return the value that was replaced but instead return null

Returns:

MapBuilder with this configuration applied

See Also:

MapBuilder.removeReturnsNull(boolean)

removeReturnsNull

public ChronicleMapStatelessClientBuilder<K,V> removeReturnsNull(boolean removeReturnsNull)

Description copied from interface: MapBuilder

Configures if the maps created by this MapBuilder should return null instead of the last mapped value on ChronicleMap.remove(key) calls.

Map.remove() returns the previous value, functionality which is rarely used but fairly cheap for simple in-process, on-heap implementations like HashMap. But an off-heap collection has to create a new object and deserialize the data from off-heap memory. A collection hiding remote queries over the network should send the value back in addition to that. It's expensive for something you probably don't use.

By default, of cause, ChronicleMap conforms the general Map contract and returns the mapped value on remove() calls.

Specified by:

removeReturnsNull in interface MapBuilder<ChronicleMapStatelessClientBuilder<K,V>>

Parameters:

removeReturnsNull - true if you want ChronicleMap.remove() to not return the value of the removed entry but instead return null

Returns:

MapBuilder with this configuration applied

See Also:

MapBuilder.putReturnsNull(boolean)

timeout

public ChronicleMapStatelessClientBuilder<K,V> timeout(long timeout,
                                              TimeUnit units)

Specified by:

timeout in interface ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>

name

public ChronicleMapStatelessClientBuilder<K,V> name(String name)

Specified by:

name in interface ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>

tcpBufferSize

public ChronicleMapStatelessClientBuilder<K,V> tcpBufferSize(int tcpBufferSize)

Specified by:

tcpBufferSize in interface ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>

create

public ChronicleMap<K,V> create()
                         throws IOException

Specified by:

create in interface ChronicleHashStatelessClientBuilder<ChronicleMapStatelessClientBuilder<K,V>,ChronicleMap<K,V>>

Throws:

IOException