SharedHashMapBuilder (OpenHFT/Chronicle-Map 1.0.0 API)

java.lang.Object
- net.openhft.collections.SharedHashMapBuilder<K,V>

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: ChronicleMapBuilder

public class SharedHashMapBuilder<K,V>
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`FILE_REPLICATION_MODIFICATION_ITERATOR_ID`
`static short`	`JDBC_REPLICATION_MODIFICATION_ITERATOR_ID`
`static short`	`UDP_REPLICATION_MODIFICATION_ITERATOR_ID`

Constructor Summary

Constructors
Constructor and Description

SharedHashMapBuilder()

SharedHashMapBuilder(Class<K> kClass, Class<V> vClass)

Constructors
Constructor and Description
`SharedHashMapBuilder()`
`SharedHashMapBuilder(Class<K> kClass, Class<V> vClass)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`actualEntriesPerSegment()`
`SharedHashMapBuilder<K,V>`	`actualEntriesPerSegment(int actualEntriesPerSegment)`
`int`	`actualSegments()`
`SharedHashMapBuilder<K,V>`	`actualSegments(int actualSegments)`
`net.openhft.lang.io.serialization.BytesMarshallerFactory`	`bytesMarshallerFactory()`
`SharedHashMapBuilder`	`bytesMarshallerFactory(net.openhft.lang.io.serialization.BytesMarshallerFactory bytesMarshallerFactory)`
`boolean`	`canReplicate()`
`SharedHashMapBuilder`	`canReplicate(boolean canReplicate)`
`SharedHashMapBuilder<K,V>`	`clone()`
`ChronicleMap<K,V>`	`create()`
`<K,V> ChronicleMap<K,V>`	`create(File file, Class<K> kClass, Class<V> vClass)` Deprecated.
`long`	`entries()`
`SharedHashMapBuilder<K,V>`	`entries(long entries)`
`net.openhft.collections.Alignment`	`entryAndValueAlignment()` Returns alignment of addresses in memory of entries and independently of values within entries.
`SharedHashMapBuilder<K,V>`	`entryAndValueAlignment(net.openhft.collections.Alignment alignment)` Specifies alignment of address in memory of entries and independently of address in memory of values within entries.
`int`	`entrySize()`
`SharedHashMapBuilder`	`entrySize(int entrySize)` Note that the actual entrySize will be aligned to 4 (default entry alignment).
`boolean`	`equals(Object o)`
`net.openhft.collections.SharedMapErrorListener`	`errorListener()`
`SharedHashMapBuilder`	`errorListener(net.openhft.collections.SharedMapErrorListener errorListener)`
`net.openhft.collections.SharedMapEventListener`	`eventListener()`
`SharedHashMapBuilder`	`eventListener(net.openhft.collections.SharedMapEventListener eventListener)`
`File`	`file()`
`SharedHashMapBuilder<K,V>`	`file(File file)`
`boolean`	`generatedKeyType()`
`SharedHashMapBuilder`	`generatedKeyType(boolean generatedKeyType)`
`boolean`	`generatedValueType()`
`SharedHashMapBuilder`	`generatedValueType(boolean generatedValueType)`
`int`	`hashCode()`
`byte`	`identifier()`
`SharedHashMapBuilder`	`identifier(byte identifier)`
`<K> Class<K>`	`kClass()`
`SharedHashMapBuilder`	`kClass(Class kClass)`
`boolean`	`largeSegments()`
`SharedHashMapBuilder`	`largeSegments(boolean largeSegments)`
`long`	`lockTimeOutMS()`
`SharedHashMapBuilder`	`lockTimeOutMS(long lockTimeOutMS)`
`int`	`metaDataBytes()`
`SharedHashMapBuilder`	`metaDataBytes(int metaDataBytes)`
`int`	`minSegments()`
`SharedHashMapBuilder`	`minSegments(int minSegments)` Set minimum number of segments.
`net.openhft.lang.io.serialization.ObjectSerializer`	`objectSerializer()`
`SharedHashMapBuilder`	`objectSerializer(net.openhft.lang.io.serialization.ObjectSerializer objectSerializer)`
`static <K,V> SharedHashMapBuilder<K,V>`	`of(Class<K> kClass, Class<V> vClass)`
`boolean`	`putReturnsNull()` Map.put() returns the previous value, functionality which is rarely used but fairly cheap for HashMap.
`SharedHashMapBuilder`	`putReturnsNull(boolean putReturnsNull)` Map.put() returns the previous value, functionality which is rarely used but fairly cheap for HashMap.
`boolean`	`removeReturnsNull()` Map.remove() returns the previous value, functionality which is rarely used but fairly cheap for HashMap.
`SharedHashMapBuilder`	`removeReturnsNull(boolean removeReturnsNull)` Map.remove() returns the previous value, functionality which is rarely used but fairly cheap for HashMap.
`int`	`replicas()`
`SharedHashMapBuilder<K,V>`	`replicas(int replicas)`
`net.openhft.collections.TcpReplicatorBuilder`	`tcpReplicatorBuilder()`
`SharedHashMapBuilder`	`tcpReplicatorBuilder(net.openhft.collections.TcpReplicatorBuilder tcpReplicatorBuilder)`
`net.openhft.collections.TimeProvider`	`timeProvider()`
`SharedHashMapBuilder`	`timeProvider(net.openhft.collections.TimeProvider timeProvider)`
`String`	`toString()`
`boolean`	`transactional()`
`SharedHashMapBuilder<K,V>`	`transactional(boolean transactional)` Not supported yet.
`net.openhft.collections.UdpReplicatorBuilder`	`udpReplicatorBuilder()`
`SharedHashMapBuilder`	`udpReplicatorBuilder(net.openhft.collections.UdpReplicatorBuilder udpReplicatorBuilder)`
`<V> Class<V>`	`vClass()`
`SharedHashMapBuilder`	`vClass(Class vClass)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- UDP_REPLICATION_MODIFICATION_ITERATOR_ID
```
public static final short UDP_REPLICATION_MODIFICATION_ITERATOR_ID
```
  See Also:
  
  Constant Field Values
- JDBC_REPLICATION_MODIFICATION_ITERATOR_ID
```
public static final short JDBC_REPLICATION_MODIFICATION_ITERATOR_ID
```
  See Also:
  
  Constant Field Values
- FILE_REPLICATION_MODIFICATION_ITERATOR_ID
```
public static final short FILE_REPLICATION_MODIFICATION_ITERATOR_ID
```
  See Also:
  
  Constant Field Values

Constructor Detail

SharedHashMapBuilder
```
public SharedHashMapBuilder()
```

SharedHashMapBuilder

public SharedHashMapBuilder(Class<K> kClass,
                            Class<V> vClass)

Method Detail
- of
```
public static <K,V> SharedHashMapBuilder<K,V> of(Class<K> kClass,
                                                 Class<V> vClass)
```
- clone
```
public SharedHashMapBuilder<K,V> clone()
```
  Overrides:
  
  clone in class Object
- minSegments
```
public SharedHashMapBuilder minSegments(int minSegments)
```
  Set minimum number of segments. See concurrencyLevel in ConcurrentHashMap.
  
  Returns:
  
  this builder object back
- minSegments
```
public int minSegments()
```
- entrySize
```
public SharedHashMapBuilder entrySize(int entrySize)
```
  Note that the actual entrySize will be aligned to 4 (default entry alignment). I. e. if you set entry size to 30, the actual entry size will be 32 (30 aligned to 4 bytes). If you don't want entry size to be aligned, set entryAndValueAlignment(Alignment.NO_ALIGNMENT).
  
  Parameters:
  
  entrySize - the size in bytes
  
  Returns:
  
  this SharedHashMapBuilder back
  
  See Also:
  
  entryAndValueAlignment(Alignment), entryAndValueAlignment()
- entrySize
```
public int entrySize()
```
- entryAndValueAlignment
```
public SharedHashMapBuilder<K,V> entryAndValueAlignment(net.openhft.collections.Alignment alignment)
```
  Specifies alignment of address in memory of entries and independently of address in memory of values within entries.
  
  Useful when values of the map are updated intensively, particularly fields with volatile access, because it doesn't work well if the value crosses cache lines. Also, on some (nowadays rare) architectures any misaligned memory access is more expensive than aligned.
  
  Note that specified entrySize() will be aligned according to this alignment. I. e. if you set entrySize(20) and Alignment.OF_8_BYTES, actual entry size will be 24 (20 aligned to 8 bytes).
  
  Returns:
  
  this SharedHashMapBuilder back
  
  See Also:
  
  entryAndValueAlignment()
- entryAndValueAlignment
```
public net.openhft.collections.Alignment entryAndValueAlignment()
```
  Returns alignment of addresses in memory of entries and independently of values within entries.
  
  Default is Alignment.OF_4_BYTES.
  
  See Also:
  
  entryAndValueAlignment(Alignment)
- entries
```
public SharedHashMapBuilder<K,V> entries(long entries)
```
- entries
```
public long entries()
```
- replicas
```
public SharedHashMapBuilder<K,V> replicas(int replicas)
```
- replicas
```
public int replicas()
```
- actualEntriesPerSegment
```
public SharedHashMapBuilder<K,V> actualEntriesPerSegment(int actualEntriesPerSegment)
```
- actualEntriesPerSegment
```
public int actualEntriesPerSegment()
```
- actualSegments
```
public SharedHashMapBuilder<K,V> actualSegments(int actualSegments)
```
- actualSegments
```
public int actualSegments()
```
- transactional
```
public SharedHashMapBuilder<K,V> transactional(boolean transactional)
```
  Not supported yet.
  
  Parameters:
  
  transactional - if the built map should be transactional
  
  Returns:
  
  this SharedHashMapBuilder back
- transactional
```
public boolean transactional()
```
- kClass
```
public SharedHashMapBuilder kClass(Class kClass)
```
- vClass
```
public SharedHashMapBuilder vClass(Class vClass)
```
- file
```
public SharedHashMapBuilder<K,V> file(File file)
```
- file
```
public File file()
```
- kClass
```
public <K> Class<K> kClass()
```
- vClass
```
public <V> Class<V> vClass()
```
- create
```
public ChronicleMap<K,V> create()
                         throws IOException
```
  Throws:
  
  IOException
- create
```
@Deprecated
public <K,V> ChronicleMap<K,V> create(File file,
                                                  Class<K> kClass,
                                                  Class<V> vClass)
                                           throws IOException
```
  Deprecated.
  
  Its recommended that you use net.openhft.collections.SharedHashMapBuilder#create() instead as this method will be shortly removed
  
  Throws:
  
  IOException
- lockTimeOutMS
```
public SharedHashMapBuilder lockTimeOutMS(long lockTimeOutMS)
```
- lockTimeOutMS
```
public long lockTimeOutMS()
```
- errorListener
```
public SharedHashMapBuilder errorListener(net.openhft.collections.SharedMapErrorListener errorListener)
```
- errorListener
```
public net.openhft.collections.SharedMapErrorListener errorListener()
```
- putReturnsNull
```
public SharedHashMapBuilder putReturnsNull(boolean putReturnsNull)
```
  Map.put() returns the previous value, functionality which is rarely used but fairly cheap for HashMap. In the case, for an off heap collection, it has to create a new object (or return a recycled one) Either way it's expensive for something you probably don't use.
  
  Parameters:
  
  putReturnsNull - false if you want SharedHashMap.put() to not return the object that was replaced but instead return null
  
  Returns:
  
  an instance of the map builder
- putReturnsNull
```
public boolean putReturnsNull()
```
  Map.put() returns the previous value, functionality which is rarely used but fairly cheap for HashMap. In the case, for an off heap collection, it has to create a new object (or return a recycled one) Either way it's expensive for something you probably don't use.
  
  Returns:
  
  true if SharedHashMap.put() is not going to return the object that was replaced but instead return null
- removeReturnsNull
```
public SharedHashMapBuilder removeReturnsNull(boolean removeReturnsNull)
```
  Map.remove() returns the previous value, functionality which is rarely used but fairly cheap for HashMap. In the case, for an off heap collection, it has to create a new object (or return a recycled one) Either way it's expensive for something you probably don't use.
  
  Parameters:
  
  removeReturnsNull - false if you want SharedHashMap.remove() to not return the object that was removed but instead return null
  
  Returns:
  
  an instance of the map builder
- removeReturnsNull
```
public boolean removeReturnsNull()
```
  Map.remove() returns the previous value, functionality which is rarely used but fairly cheap for HashMap. In the case, for an off heap collection, it has to create a new object (or return a recycled one) Either way it's expensive for something you probably don't use.
  
  Returns:
  
  true if SharedHashMap.remove() is not going to return the object that was removed but instead return null
- generatedKeyType
```
public boolean generatedKeyType()
```
- generatedKeyType
```
public SharedHashMapBuilder generatedKeyType(boolean generatedKeyType)
```
- generatedValueType
```
public boolean generatedValueType()
```
- generatedValueType
```
public SharedHashMapBuilder generatedValueType(boolean generatedValueType)
```
- largeSegments
```
public boolean largeSegments()
```
- largeSegments
```
public SharedHashMapBuilder largeSegments(boolean largeSegments)
```
- metaDataBytes
```
public SharedHashMapBuilder metaDataBytes(int metaDataBytes)
```
- metaDataBytes
```
public int metaDataBytes()
```
- eventListener
```
public SharedHashMapBuilder eventListener(net.openhft.collections.SharedMapEventListener eventListener)
```
- eventListener
```
public net.openhft.collections.SharedMapEventListener eventListener()
```
- 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
- canReplicate
```
public boolean canReplicate()
```
- canReplicate
```
public SharedHashMapBuilder canReplicate(boolean canReplicate)
```
- timeProvider
```
public SharedHashMapBuilder timeProvider(net.openhft.collections.TimeProvider timeProvider)
```
- timeProvider
```
public net.openhft.collections.TimeProvider timeProvider()
```
- identifier
```
public byte identifier()
```
- identifier
```
public SharedHashMapBuilder identifier(byte identifier)
```
- tcpReplicatorBuilder
```
public SharedHashMapBuilder tcpReplicatorBuilder(net.openhft.collections.TcpReplicatorBuilder tcpReplicatorBuilder)
```
- tcpReplicatorBuilder
```
public net.openhft.collections.TcpReplicatorBuilder tcpReplicatorBuilder()
```
- udpReplicatorBuilder
```
public net.openhft.collections.UdpReplicatorBuilder udpReplicatorBuilder()
```
- udpReplicatorBuilder
```
public SharedHashMapBuilder udpReplicatorBuilder(net.openhft.collections.UdpReplicatorBuilder udpReplicatorBuilder)
```
- bytesMarshallerFactory
```
public net.openhft.lang.io.serialization.BytesMarshallerFactory bytesMarshallerFactory()
```
- bytesMarshallerFactory
```
public SharedHashMapBuilder bytesMarshallerFactory(net.openhft.lang.io.serialization.BytesMarshallerFactory bytesMarshallerFactory)
```
- objectSerializer
```
public net.openhft.lang.io.serialization.ObjectSerializer objectSerializer()
```
- objectSerializer
```
public SharedHashMapBuilder objectSerializer(net.openhft.lang.io.serialization.ObjectSerializer objectSerializer)
```

Class SharedHashMapBuilder<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UDP_REPLICATION_MODIFICATION_ITERATOR_ID

JDBC_REPLICATION_MODIFICATION_ITERATOR_ID

FILE_REPLICATION_MODIFICATION_ITERATOR_ID

Constructor Detail

SharedHashMapBuilder

SharedHashMapBuilder

Method Detail

of

clone

minSegments

minSegments

entrySize

entrySize

entryAndValueAlignment

entryAndValueAlignment

entries

entries

replicas

replicas

actualEntriesPerSegment

actualEntriesPerSegment

actualSegments

actualSegments

transactional

transactional

kClass

vClass

file

file

kClass

vClass

create

create

lockTimeOutMS

lockTimeOutMS

errorListener

errorListener

putReturnsNull

putReturnsNull

removeReturnsNull

removeReturnsNull

generatedKeyType

generatedKeyType

generatedValueType

generatedValueType

largeSegments

largeSegments

metaDataBytes

metaDataBytes

eventListener

eventListener

toString

equals

hashCode

canReplicate

canReplicate

timeProvider

timeProvider

identifier

identifier

tcpReplicatorBuilder

tcpReplicatorBuilder

udpReplicatorBuilder

udpReplicatorBuilder

bytesMarshallerFactory

bytesMarshallerFactory

objectSerializer

objectSerializer