K
- key type of the maps, produced by this builderV
- value type of the maps, produced by this builderpublic final class ChronicleMapBuilder<K,V> extends Object implements net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>, MapBuilder<ChronicleMapBuilder<K,V>>, Serializable
ChronicleMapBuilder
manages ChronicleMap
configurations; could be used as a
classic builder and/or factory. This means that in addition to the standard builder usage
pattern:
ChronicleMap<Key, Value> map = ChronicleMapOnHeapUpdatableBuilder
.of(Key.class, Value.class)
.entries(100500)
// ... other configurations
.create();
it could be prepared and used to create many similar maps:
ChronicleMapBuilder<Key, Value> builder = ChronicleMapBuilder
.of(Key.class, Value.class)
.entries(100500);
ChronicleMap<Key, Value> map1 = builder.create();
ChronicleMap<Key, Value> map2 = builder.create();
i. e. created ChronicleMap
instances don't depend on the builder.
ChronicleMapBuilder
is mutable, see a note in ChronicleHashBuilder
interface
documentation.
Later in this documentation, "ChronicleMap" means "ChronicleMaps, created by ChronicleMapBuilder
", unless specified different, because theoretically someone might provide
ChronicleMap
implementations with completely different properties.
ChronicleMap
("ChronicleMaps, created by ChronicleMapBuilder
") currently
doesn't support resizing. That is why you must configure number
of entries you are going to insert into the created map at most. See entries(long)
method documentation for more information on this.
If you key or value type is not constantly sized and known to ChronicleHashBuilder
, i.
e. it is not a boxed primitive, data value generated interface, Byteable
, etc. (see the
complete list TODO insert the link to the complete list), you must provide the ChronicleHashBuilder
with some information about you keys or values: if they are
constantly-sized, call constantKeySizeBySample(Object)
, otherwise ChronicleHashBuilder.averageKeySize(double)
method, accordingly for values.ChronicleMap
,
ChronicleSetBuilder
,
Serialized FormModifier and Type | Method and Description |
---|---|
ChronicleMapBuilder<K,V> |
actualChunkSize(int actualChunkSize)
Configures the size in bytes of allocation unit of hash container instances, created by this
builder.
|
long |
actualChunksPerSegment(boolean replicated) |
ChronicleMapBuilder<K,V> |
actualChunksPerSegment(long actualChunksPerSegment)
Configures the actual number of chunks, that will be reserved for any single segment of the
hash containers, created by this builder.
|
int |
actualSegments(boolean replicated) |
ChronicleMapBuilder<K,V> |
actualSegments(int actualSegments)
Configures the actual number of segments in the hash containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
averageKeySize(double averageKeySize)
Configures the average number of bytes, taken by serialized form of keys, put into hash
containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
averageValueSize(double averageValueSize)
Configures the average number of bytes, taken by serialized form of values, put into maps,
created by this builder.
|
ChronicleMapBuilder<K,V> |
bytesMarshallerFactory(BytesMarshallerFactory bytesMarshallerFactory)
Configures a
BytesMarshallerFactory to be used with BytesMarshallableSerializer , which is a default ObjectSerializer ,
to serialize/deserialize data to/from off-heap memory in hash containers, created by this
builder. |
long |
chunkSize(boolean replicated) |
ChronicleMapBuilder<K,V> |
clone()
Clones this builder.
|
ChronicleMapBuilder<K,V> |
constantKeySizeBySample(K sampleKey)
Configures the constant number of bytes, taken by serialized form of keys, put into hash
containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
constantValueSizeBySample(V sampleValue)
Configures the constant number of bytes, taken by serialized form of values, put into maps,
created by this builder.
|
ChronicleMap<K,V> |
create()
Creates a new hash container, storing it's data in off-heap memory, not mapped to any file.
|
ChronicleMap<K,V> |
createPersistedTo(File file)
Opens a hash container residing the specified file, or creates a new one if the file not yet
exists and maps its off-heap memory to the file.
|
ChronicleMapBuilder<K,V> |
defaultValue(V defaultValue)
Specifies the value to be put for each key queried in
acquireUsing() method, if the key is absent in the map, created by this builder. |
ChronicleMapBuilder<K,V> |
defaultValueProvider(DefaultValueProvider<K,V> defaultValueProvider)
Deprecated.
specialize
MapEntryOperations.defaultValue(MapAbsentEntry) instead |
ChronicleMapBuilder<K,V> |
entries(long entries)
Configures the maximum number of entries, that could be inserted into the hash containers,
created by this builder.
|
long |
entriesPerSegment(boolean replicated) |
ChronicleMapBuilder<K,V> |
entriesPerSegment(long entriesPerSegment)
Configures the actual maximum number entries, that could be inserted into any single segment
of the hash containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
entryAndValueAlignment(Alignment alignment)
Configures alignment strategy of address in memory of entries and independently of address in
memory of values within entries in ChronicleMaps, created by this builder.
|
ChronicleMapBuilder<K,V> |
entryOperations(MapEntryOperations<K,V,?> entryOperations)
Inject your SPI code around basic
ChronicleMap 's operations with entries:
removing entries, replacing the entries' value and inserting the new entry. |
boolean |
equals(Object o) |
int |
hashCode() |
ChronicleMapBuilder<K,V> |
immutableKeys()
Specifies that key objects, queried with the hash containers, created by this builder, are
inherently immutable.
|
ChronicleHashInstanceBuilder<ChronicleMap<K,V>> |
instance() |
net.openhft.chronicle.hash.serialization.internal.SerializationBuilder<K> |
keyBuilder() |
ChronicleMapBuilder<K,V> |
keyDeserializationFactory(ObjectFactory<? extends K> keyDeserializationFactory)
Configures factory which is used to create a new key instance, if key class is either
Byteable , BytesMarshallable or Externalizable subclass, or key type is
eligible for data value generation, or configured custom key reader implements DeserializationFactoryConfigurableBytesReader , in maps, created by this builder. |
ChronicleMapBuilder<K,V> |
keyMarshaller(BytesMarshaller<? super K> keyMarshaller)
Configures the
BytesMarshaller used to serialize/deserialize keys to/from off-heap
memory in hash containers, created by this builder. |
ChronicleMapBuilder<K,V> |
keyMarshallers(BytesWriter<? super K> keyWriter,
BytesReader<K> keyReader)
Configures the marshallers, used to serialize/deserialize keys to/from off-heap memory in
hash containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
keySizeMarshaller(SizeMarshaller keySizeMarshaller)
Configures the marshaller used to serialize actual key sizes to off-heap memory in hash
containers, created by this builder.
|
ChronicleMapBuilder<K,V> |
mapMethods(MapMethods<K,V,?> mapMethods)
Inject your SPI around logic of all
ChronicleMap 's operations with individual keys:
from Map.containsKey(java.lang.Object) to ChronicleMap.acquireUsing(K, V) and
ConcurrentMap.merge(K, V, java.util.function.BiFunction<? super V, ? super V, ? extends V>) . |
int |
maxChunksPerEntry() |
ChronicleMapBuilder<K,V> |
maxChunksPerEntry(int maxChunksPerEntry)
Configures how many chunks a single entry, inserted into
ChronicleHash es, created
by this builder, could take. |
ChronicleMapBuilder<K,V> |
minSegments(int minSegments)
Set minimum number of segments in hash containers, constructed by this builder.
|
ChronicleMapBuilder<K,V> |
objectSerializer(ObjectSerializer objectSerializer)
Configures the serializer used to serialize/deserialize data to/from off-heap memory, when
specified class doesn't implement a specific serialization interface like
Externalizable or BytesMarshallable (for example, if data is loosely typed and just
Object is specified as the data class), or nullable data, and if custom marshaller is
not configured, in hash containers, created by
this builder. |
static <K,V> ChronicleMapBuilder<K,V> |
of(Class<K> keyClass,
Class<V> valueClass)
Returns a new
ChronicleMapBuilder instance which is able to create maps with the specified key and value classes. |
static <K,V> ChronicleMapStatelessClientBuilder<K,V> |
of(Class<K> keyClass,
Class<V> valueClass,
InetSocketAddress socketAddress) |
ChronicleMapBuilder<K,V> |
pushTo(InetSocketAddress... addresses) |
ChronicleMapBuilder<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. |
ChronicleMapBuilder<K,V> |
remoteOperations(MapRemoteOperations<K,V,?> remoteOperations) |
ChronicleMapBuilder<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. |
ChronicleMapBuilder<K,V> |
replication(byte identifier) |
ChronicleMapBuilder<K,V> |
replication(byte identifier,
TcpTransportAndNetworkConfig tcpTransportAndNetwork)
Shortcut for
replication(SimpleReplication.builder() .tcpTransportAndNetwork(tcpTransportAndNetwork).createWithId(identifier)) . |
ChronicleMapBuilder<K,V> |
replication(SingleChronicleHashReplication replication)
Configures replication of the hash containers, created by this builder.
|
int |
segmentEntrySpaceInnerOffset(boolean replicated)
This is needed, if chunkSize = constant entry size is not aligned, for entry alignment to be
always the same, we should _misalign_ the first chunk.
|
int |
segmentHeaderSize(boolean replicated) |
ChronicleMapBuilder<K,V> |
timeProvider(TimeProvider timeProvider)
Configures a time provider, used by hash containers, created by this builder, for needs of
replication consensus protocol (conflicting data updates resolution).
|
String |
toString() |
ChronicleMapBuilder<K,V> |
valueDeserializationFactory(ObjectFactory<V> valueDeserializationFactory)
Configures factory which is used to create a new value instance, if value class is either
Byteable , BytesMarshallable or Externalizable subclass, or value type
is eligible for data value generation, or configured custom value reader is an instance of
DeserializationFactoryConfigurableBytesReader , in maps, created by this builder. |
ChronicleMapBuilder<K,V> |
valueMarshaller(BytesMarshaller<? super V> valueMarshaller)
Configures the
BytesMarshaller used to serialize/deserialize values to/from off-heap
memory in maps, created by this builder. |
ChronicleMapBuilder<K,V> |
valueMarshallers(BytesWriter<V> valueWriter,
BytesReader<V> valueReader)
Configures the marshallers, used to serialize/deserialize values to/from off-heap memory in
maps, created by this builder.
|
ChronicleMapBuilder<K,V> |
valueSizeMarshaller(SizeMarshaller valueSizeMarshaller)
Configures the marshaller used to serialize actual value sizes to off-heap memory in maps,
created by this builder.
|
public static <K,V> ChronicleMapBuilder<K,V> of(@NotNull Class<K> keyClass, @NotNull Class<V> valueClass)
ChronicleMapBuilder
instance which is able to create maps with the specified key and value classes.K
- key type of the maps, created by the returned builderV
- value type of the maps, created by the returned builderkeyClass
- class object used to infer key type and discover it's properties via
reflectionvalueClass
- class object used to infer value type and discover it's properties via
reflectionpublic static <K,V> ChronicleMapStatelessClientBuilder<K,V> of(@NotNull Class<K> keyClass, @NotNull Class<V> valueClass, InetSocketAddress socketAddress)
public ChronicleMapBuilder<K,V> pushTo(InetSocketAddress... addresses)
public ChronicleMapBuilder<K,V> clone()
ChronicleHashBuilder
ChronicleHashBuilder
s are mutable and changed on each configuration method call. Original
and cloned builders are independent.clone
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
clone
in class Object
public ChronicleMapBuilder<K,V> averageKeySize(double averageKeySize)
ChronicleHashBuilder.constantKeySizeBySample(Object)
method instead of this one.
ChronicleHashBuilder
implementation heuristically chooses
the actual chunk size based on this configuration, that,
however, might result to quite high internal fragmentation, i. e. losses because only
integral number of chunks could be allocated for the entry. If you want to avoid this, you
should manually configure the actual chunk size in addition to this average key size
configuration, which is anyway needed.
If key is a boxed primitive type or Byteable
subclass, i. e. if key size is known
statically, it is automatically accounted and shouldn't be specified by user.
Example: if keys in your map(s) are English words in String
form, average English
word length is 5.1, configure average key size of 6:
ChronicleMap<String, LongValue> wordFrequencies = ChronicleMapBuilder
.of(String.class, LongValue.class)
.entries(50000)
.averageKeySize(6)
.create();
(Note that 6 is chosen as average key size in bytes despite strings in Java are UTF-16
encoded (and each character takes 2 bytes on-heap), because default off-heap String
encoding is UTF-8 in ChronicleMap
.)averageKeySize
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
averageKeySize
- the average size of the keyIllegalStateException
- if key size is known statically and shouldn't be configured
by userIllegalArgumentException
- if the given keySize
is non-positiveconstantKeySizeBySample(Object)
,
averageValueSize(double)
,
actualChunkSize(int)
public ChronicleMapBuilder<K,V> constantKeySizeBySample(K sampleKey)
sampleKey
, all
keys should take the same number of bytes in serialized form, as this sample object.
If keys are of boxed primitive type or Byteable
subclass, i. e. if key size is
known statically, it is automatically accounted and this method shouldn't be called.
If key size varies, method ChronicleHashBuilder.averageKeySize(double)
should be called instead of
this one.
For example, if your keys are Git commit hashes:
Map<byte[], String> gitCommitMessagesByHash =
ChronicleMapBuilder.of(byte[].class, String.class)
.constantKeySizeBySample(new byte[20])
.immutableKeys()
.create();
constantKeySizeBySample
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
sampleKey
- the sample keyChronicleHashBuilder.averageKeySize(double)
,
constantValueSizeBySample(Object)
public ChronicleMapBuilder<K,V> averageValueSize(double averageValueSize)
constantValueSizeBySample(Object)
method instead of this one.
ChronicleHashBuilder
implementation heuristically chooses the actual chunk size based on this configuration and the key size,
that, however, might result to quite high internal fragmentation, i. e. losses because only
integral number of chunks could be allocated for the entry. If you want to avoid this, you
should manually configure the actual chunk size in addition to this average value size
configuration, which is anyway needed.
If values are of boxed primitive type or Byteable
subclass, i. e. if value size is
known statically, it is automatically accounted and shouldn't be specified by user.averageValueSize
- number of bytes, taken by serialized form of valuesIllegalStateException
- if value size is known statically and shouldn't be
configured by userIllegalArgumentException
- if the given averageValueSize
is non-positiveconstantValueSizeBySample(Object)
,
ChronicleHashBuilder.averageKeySize(double)
,
actualChunkSize(int)
public ChronicleMapBuilder<K,V> constantValueSizeBySample(V sampleValue)
sampleValue
, all values should
take the same number of bytes in serialized form, as this sample object.
If values are of boxed primitive type or Byteable
subclass, i. e. if value size is
known statically, it is automatically accounted and this method shouldn't be called.
If value size varies, method averageValueSize(double)
should be called instead of
this one.sampleValue
- the sample valueaverageValueSize(double)
,
constantKeySizeBySample(Object)
public ChronicleMapBuilder<K,V> actualChunkSize(int actualChunkSize)
ChronicleMap
and ChronicleSet
store their data off-heap, so it is required
to serialize key (and values, in ChronicleMap
case) (unless they are direct Byteable
instances). Serialized key bytes (+ serialized value bytes, in ChronicleMap
case) + some metadata bytes comprise "entry space", which ChronicleMap
or ChronicleSet
should allocate. So chunk size is the minimum allocation portion in the
hash containers, created by this builder. E. g. if chunk size is 100, the created container
could only allocate 100, 200, 300... bytes for an entry. If say 150 bytes of entry space are
required by the entry, 200 bytes will be allocated, 150 used and 50 wasted. This is called
internal fragmentation.
To minimize memory overuse and improve speed, you should pay decent attention to this configuration. Alternatively, you can just trust the heuristics and doesn't configure the chunk size.
Specify chunk size so that most entries would take from 5 to several dozens of chunks. However, remember that operations with entries that span several chunks are a bit slower, than with entries which take a single chunk. Particularly avoid entries to take more than 64 chunks.
Example: if values in your ChronicleMap
are adjacency lists of some social graph,
where nodes are represented as long
ids, and adjacency lists are serialized in
efficient manner, for example as long[]
arrays. Typical number of connections is
100-300, maximum is 3000. In this case chunk size of
30 * (8 bytes for each id) = 240 bytes would be a good choice:
Map<Long, long[]> socialGraph = ChronicleMapOnHeapUpdatableBuilder
.of(Long.class, long[].class)
.entries(1_000_000_000L)
.averageValueSize(150 * 8) // 150 is average adjacency list size
.actualChunkSize(30 * 8) // average 5-6 chunks per entry
.create();
This is a low-level configuration. The configured number of bytes is strictly used as-is, without anything like round-up to the multiple of 8 or 16, or any other adjustment.
actualChunkSize
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
actualChunkSize
- the "chunk size" in bytesIllegalStateException
- is sizes of both keys and values of maps created by this
builder are constant, hence chunk size shouldn't be configured
by userentryAndValueAlignment(Alignment)
,
entries(long)
,
maxChunksPerEntry(int)
public net.openhft.chronicle.hash.serialization.internal.SerializationBuilder<K> keyBuilder()
keyBuilder
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public int segmentEntrySpaceInnerOffset(boolean replicated)
segmentEntrySpaceInnerOffset
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public long chunkSize(boolean replicated)
chunkSize
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> maxChunksPerEntry(int maxChunksPerEntry)
ChronicleHashBuilder
ChronicleHash
es, created
by this builder, could take. If you try to insert larger entry, IllegalStateException
is fired. This is useful as self-check, that you configured chunk size right and you
keys (and values, in ChronicleMap
case) take expected number of bytes. For example,
if ChronicleHashBuilder.constantKeySizeBySample(Object)
is configured or key size is statically known
to be constant (boxed primitives, data value generated implementations, Byteable
s,
etc.), and the same for value objects in ChronicleMap
case, max chunks per entry
is configured to 1, to ensure keys and values are actually constantly-sized.maxChunksPerEntry
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
maxChunksPerEntry
- how many chunks a single entry could span at mostChronicleHashBuilder.actualChunkSize(int)
public int maxChunksPerEntry()
maxChunksPerEntry
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> entryAndValueAlignment(Alignment alignment)
Byteable
or "data
value generated"), alignment configuration makes no sense and forbidden.
Default is Alignment.NO_ALIGNMENT
if values couldn't reference off-heap memory,
otherwise chosen heuristically (configure explicitly for being sure and to compare
performance in your case).alignment
- the new alignment of the maps constructed by this builderChronicleMapOnHeapUpdatableBuilder
backIllegalStateException
- if values of maps, created by this builder, couldn't reference
off-heap memorypublic ChronicleMapBuilder<K,V> entries(long entries)
ChronicleHashBuilder
IllegalStateException
might be thrown, because currently ChronicleMap
and ChronicleSet
don't support resizing.
You shouldn't put additional margin over the actual maximum number of entries.
This bad practice was popularized by HashMap.HashMap(int)
and HashSet.HashSet(int)
constructors, which accept capacity, that should be multiplied
by load factor to obtain the actual maximum expected number of entries.
ChronicleMap
and ChronicleSet
don't have a notion of load factor.
Default maximum entries is 2^20 (~ 1 million).
entries
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
entries
- maximum size of the maps or sets, created by this builderpublic ChronicleMapBuilder<K,V> entriesPerSegment(long entriesPerSegment)
ChronicleHashBuilder
ChronicleHashBuilder.entries(long)
configuration.
This is a low-level configuration.
entriesPerSegment
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
entriesPerSegment
- the actual maximum number entries per segment in the
hash containers, created by this builderChronicleHashBuilder.entries(long)
,
ChronicleHashBuilder.actualSegments(int)
public long entriesPerSegment(boolean replicated)
entriesPerSegment
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> actualChunksPerSegment(long actualChunksPerSegment)
ChronicleHashBuilder
ChronicleHashBuilder.entriesPerSegment(long)
. Makes sense only if ChronicleHashBuilder.actualChunkSize(int)
,
ChronicleHashBuilder.actualSegments(int)
and ChronicleHashBuilder.entriesPerSegment(long)
are also configured
manually.actualChunksPerSegment
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
actualChunksPerSegment
- the actual number of segments, reserved per segment in the
hash containers, created by this builderpublic long actualChunksPerSegment(boolean replicated)
actualChunksPerSegment
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> minSegments(int minSegments)
ChronicleHashBuilder
ConcurrentHashMap
.minSegments
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
minSegments
- the minimum number of segments in containers, constructed by this builderpublic ChronicleMapBuilder<K,V> actualSegments(int actualSegments)
ChronicleHashBuilder
ChronicleHashBuilder.entries(long)
call.
This is a low-level configuration. The configured number is used as-is, without anything like round-up to the closest power of 2.
actualSegments
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
actualSegments
- the actual number of segments in hash containers, created by
this builderChronicleHashBuilder.minSegments(int)
,
ChronicleHashBuilder.entriesPerSegment(long)
public int actualSegments(boolean replicated)
actualSegments
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public int segmentHeaderSize(boolean replicated)
segmentHeaderSize
in interface net.openhft.chronicle.hash.impl.ChronicleHashBuilderImpl<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> putReturnsNull(boolean putReturnsNull)
MapBuilder
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.
putReturnsNull
in interface MapBuilder<ChronicleMapBuilder<K,V>>
putReturnsNull
- true
if you want ChronicleMap.put()
to not return the value that was replaced but
instead return null
MapBuilder
with this configuration appliedMapBuilder.removeReturnsNull(boolean)
public ChronicleMapBuilder<K,V> removeReturnsNull(boolean removeReturnsNull)
MapBuilder
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.
removeReturnsNull
in interface MapBuilder<ChronicleMapBuilder<K,V>>
removeReturnsNull
- true
if you want ChronicleMap.remove()
to not return the value of the removed entry
but instead return null
MapBuilder
with this configuration appliedMapBuilder.putReturnsNull(boolean)
public ChronicleMapBuilder<K,V> timeProvider(TimeProvider timeProvider)
ChronicleHashBuilder
Default time provider is TimeProvider.SYSTEM
.
timeProvider
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
timeProvider
- a new time provider for replication needsChronicleHashBuilder.replication(SingleChronicleHashReplication)
public ChronicleMapBuilder<K,V> bytesMarshallerFactory(BytesMarshallerFactory bytesMarshallerFactory)
ChronicleHashBuilder
BytesMarshallerFactory
to be used with BytesMarshallableSerializer
, which is a default ObjectSerializer
,
to serialize/deserialize data to/from off-heap memory in hash containers, created by this
builder.
Default BytesMarshallerFactory
is an instance of VanillaBytesMarshallerFactory
. This is a convenience configuration method, it has no effect
on the resulting hash containers, if custom data
marshallers are configured, data types extends one of specific serialization interfaces,
recognized by this builder (e. g. Externalizable
or BytesMarshallable
), or
ObjectSerializer
is configured.
bytesMarshallerFactory
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
bytesMarshallerFactory
- the marshaller factory to be used with the default ObjectSerializer
, i. e. BytesMarshallableSerializer
ChronicleHashBuilder.objectSerializer(ObjectSerializer)
public ChronicleMapBuilder<K,V> objectSerializer(ObjectSerializer objectSerializer)
Externalizable
or BytesMarshallable
(for example, if data is loosely typed and just
Object
is specified as the data class), or nullable data, and if custom marshaller is
not configured, in hash containers, created by
this builder. Please read ObjectSerializer
docs for more info and available options.
Default serializer is BytesMarshallableSerializer
, configured with the specified
or default BytesMarshallerFactory
.
Example:
Map<Key, Value> map =
ChronicleMapBuilder.of(Key.class, Value.class)
.entries(1_000_000)
.averageKeySize(50).averageValueSize(200)
// this class hasn't implemented yet, just for example
.objectSerializer(new KryoObjectSerializer())
.create();
This serializer is used to serialize both keys and values, if they both require this:
loosely typed, nullable, and custom key and
value marshallers are not configured.objectSerializer
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
objectSerializer
- the serializer used to serialize loosely typed or nullable data if
custom marshaller is not configuredChronicleHashBuilder.bytesMarshallerFactory(BytesMarshallerFactory)
,
ChronicleHashBuilder.keyMarshaller(BytesMarshaller)
public ChronicleMapBuilder<K,V> keyMarshaller(@NotNull BytesMarshaller<? super K> keyMarshaller)
ChronicleHashBuilder
BytesMarshaller
used to serialize/deserialize keys to/from off-heap
memory in hash containers, created by this builder. See the
section about serialization in ChronicleMap manual for more information.keyMarshaller
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
keyMarshaller
- the marshaller used to serialize keysChronicleHashBuilder.keyMarshallers(BytesWriter, BytesReader)
,
ChronicleHashBuilder.objectSerializer(ObjectSerializer)
public ChronicleMapBuilder<K,V> keyMarshallers(@NotNull BytesWriter<? super K> keyWriter, @NotNull BytesReader<K> keyReader)
ChronicleHashBuilder
Configuring marshalling this way results to a little bit more compact in-memory layout of
the map, comparing to a single interface configuration: ChronicleHashBuilder.keyMarshaller(BytesMarshaller)
.
Passing BytesInterop
(which is a subinterface of BytesWriter
) as the first
argument is supported, and even more advantageous from performance perspective.
keyMarshallers
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
keyWriter
- the new key object → Bytes
writer (interop) strategykeyReader
- the new Bytes
→ key object reader strategyChronicleHashBuilder.keyMarshaller(BytesMarshaller)
public ChronicleMapBuilder<K,V> keySizeMarshaller(@NotNull SizeMarshaller keySizeMarshaller)
ChronicleHashBuilder
Default key size marshaller is so-called "stop bit encoding" marshalling. If constant key size is configured, or defaulted if the key
type is always constant and ChronicleHashBuilder
implementation knows about it, this
configuration takes no effect, because a special SizeMarshaller
implementation, which
doesn't actually do any marshalling, and just returns the known constant size on SizeMarshaller.readSize(Bytes)
calls, is used instead of any SizeMarshaller
configured using this method.
keySizeMarshaller
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
keySizeMarshaller
- the new marshaller, used to serialize actual key sizes to off-heap
memorypublic ChronicleMapBuilder<K,V> keyDeserializationFactory(@NotNull ObjectFactory<? extends K> keyDeserializationFactory)
ChronicleHashBuilder
Byteable
, BytesMarshallable
or Externalizable
subclass, or key type is
eligible for data value generation, or configured custom key reader implements DeserializationFactoryConfigurableBytesReader
, in maps, created by this builder.
Default key deserialization factory is NewInstanceObjectFactory
, which creates a
new key instance using Class.newInstance()
default constructor. You could provide an
AllocateInstanceObjectFactory
, which uses Unsafe.allocateInstance(Class)
(you
might want to do this for better performance or if you don't want to initialize fields), or a
factory which calls a key class constructor with some arguments, or a factory which
internally delegates to instance pool or ThreadLocal
, to reduce allocations.
keyDeserializationFactory
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
keyDeserializationFactory
- the key factory used to produce instances to deserialize
data inIllegalStateException
- if it is not possible to apply deserialization factory to
key deserializers, currently configured for this buildervalueDeserializationFactory(ObjectFactory)
public ChronicleMapBuilder<K,V> immutableKeys()
ChronicleHashBuilder
ChronicleMap
or ChronicleSet
are not required
to be immutable, as in ordinary Map
or Set
implementations, because they are
serialized off-heap. However, ChronicleMap
and ChronicleSet
implementations
can benefit from the knowledge that keys are not mutated between queries.
By default, ChronicleHashBuilder
s detects immutability automatically only for very
few standard JDK types (for example, for String
), it is not recommended to rely on
ChronicleHashBuilder
to be smart enough about this.
immutableKeys
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> valueMarshaller(@NotNull BytesMarshaller<? super V> valueMarshaller)
BytesMarshaller
used to serialize/deserialize values to/from off-heap
memory in maps, created by this builder. See the
section about serialization in ChronicleMap manual for more information.valueMarshaller
- the marshaller used to serialize valuesvalueMarshallers(BytesWriter, BytesReader)
,
objectSerializer(ObjectSerializer)
,
keyMarshaller(BytesMarshaller)
public ChronicleMapBuilder<K,V> valueMarshallers(@NotNull BytesWriter<V> valueWriter, @NotNull BytesReader<V> valueReader)
valueMarshaller(
BytesMarshaller)
. Passing BytesInterop
instead of plain BytesWriter
is, of cause, possible, but currently pointless for values.valueWriter
- the new value object → Bytes
writer (interop) strategyvalueReader
- the new Bytes
→ value object reader strategyvalueMarshaller(BytesMarshaller)
,
valueSizeMarshaller(SizeMarshaller)
,
keyMarshallers(BytesWriter, BytesReader)
public ChronicleMapBuilder<K,V> valueSizeMarshaller(@NotNull SizeMarshaller valueSizeMarshaller)
constantValueSizeBySample(Object)
or the builder statically knows the value size is
constant -- special constant size marshalling is used by default in these cases.valueSizeMarshaller
- the new marshaller, used to serialize actual value sizes to
off-heap memorykeySizeMarshaller(SizeMarshaller)
public ChronicleMapBuilder<K,V> valueDeserializationFactory(@NotNull ObjectFactory<V> valueDeserializationFactory)
Byteable
, BytesMarshallable
or Externalizable
subclass, or value type
is eligible for data value generation, or configured custom value reader is an instance of
DeserializationFactoryConfigurableBytesReader
, in maps, created by this builder.
Default value deserialization factory is NewInstanceObjectFactory
, which creates a
new value instance using Class.newInstance()
default constructor. You could provide
an AllocateInstanceObjectFactory
, which uses Unsafe.allocateInstance(Class)
(you might want to do this for better performance or if you don't want to initialize fields),
or a factory which calls a value class constructor with some arguments, or a factory which
internally delegates to instance pool or ThreadLocal
, to reduce allocations.valueDeserializationFactory
- the value factory used to produce instances to deserialize
data inIllegalStateException
- if it is not possible to apply deserialization factory to value
deserializers, currently configured for this builderkeyDeserializationFactory(ObjectFactory)
public ChronicleMapBuilder<K,V> defaultValue(V defaultValue)
acquireUsing()
method, if the key is absent in the map, created by this builder.
This configuration overrides any previous defaultValueProvider(
DefaultValueProvider)
configuration to this builder.defaultValue
- the default value to be put to the map for absent keys during acquireUsing()
callsdefaultValueProvider(DefaultValueProvider)
@Deprecated public ChronicleMapBuilder<K,V> defaultValueProvider(@NotNull DefaultValueProvider<K,V> defaultValueProvider)
MapEntryOperations.defaultValue(MapAbsentEntry)
insteadacquireUsing()
calls, if the key is absent in the map, created by this builder.
This configuration overrides any previous defaultValue(Object)
configuration
to this builder.defaultValueProvider
- the strategy to obtain a default value by the absent keydefaultValue(Object)
public ChronicleMapBuilder<K,V> replication(SingleChronicleHashReplication replication)
ChronicleHashBuilder
By default, hash containers, created by this builder doesn't replicate their data.
This method call overrides all previous replication configurations of this builder, made
either by this method or ChronicleHashBuilder.replication(byte, TcpTransportAndNetworkConfig)
shortcut
method.
replication
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
replication
- the replication configChronicleHashInstanceBuilder.replicated(SingleChronicleHashReplication)
,
ChronicleHashBuilder.replication(byte, TcpTransportAndNetworkConfig)
public ChronicleMapBuilder<K,V> replication(byte identifier)
replication
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMapBuilder<K,V> replication(byte identifier, TcpTransportAndNetworkConfig tcpTransportAndNetwork)
ChronicleHashBuilder
replication(SimpleReplication.builder() .tcpTransportAndNetwork(tcpTransportAndNetwork).createWithId(identifier))
.replication
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
identifier
- the network-wide identifier of the containers, created by this
buildertcpTransportAndNetwork
- configuration of tcp connection and networkChronicleHashBuilder.replication(SingleChronicleHashReplication)
,
ChronicleHashInstanceBuilder.replicated(byte, TcpTransportAndNetworkConfig)
public ChronicleHashInstanceBuilder<ChronicleMap<K,V>> instance()
instance
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
public ChronicleMap<K,V> createPersistedTo(File file) throws IOException
ChronicleHashBuilder
Multiple containers could give access to the same data simultaneously, either inside a single JVM or across processes. Access is synchronized correctly across all instances, i. e. hash container mapping the data from the first JVM isn't able to modify the data, concurrently accessed from the second JVM by another hash container instance, mapping the same data.
On container's close()
the data isn't removed, it remains on
disk and available to be opened again (given the same file name) or during different JVM
run.
This method is shortcut for instance().persistedTo(file).create()
.
createPersistedTo
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
file
- the file with existing hash container or a desired location of a new off-heap
persisted hash containerIOException
- if any IO error, related to off-heap memory allocation or file mapping,
or establishing replication connections, occursChronicleHash.file()
,
ChronicleHash.close()
,
ChronicleHashBuilder.create()
,
ChronicleHashInstanceBuilder.persistedTo(File)
public ChronicleMap<K,V> create()
ChronicleHashBuilder
ChronicleHash.close()
called on the returned container, or after the container
object is collected during GC, or on JVM shutdown the off-heap memory used by the returned
container is freed.
This method is a shortcut for instance().create()
.
create
in interface ChronicleHashBuilder<K,ChronicleMap<K,V>,ChronicleMapBuilder<K,V>>
ChronicleHashBuilder.createPersistedTo(File)
,
ChronicleHashBuilder.instance()
public ChronicleMapBuilder<K,V> entryOperations(MapEntryOperations<K,V,?> entryOperations)
ChronicleMap
's operations with entries:
removing entries, replacing the entries' value and inserting the new entry.
This affects behaviour of ordinary map.put(), map.remove(), etc. calls, as well as removes
and replacing values during iterations, remote map calls and
internal replication operations.public ChronicleMapBuilder<K,V> mapMethods(MapMethods<K,V,?> mapMethods)
ChronicleMap
's operations with individual keys:
from Map.containsKey(java.lang.Object)
to ChronicleMap.acquireUsing(K, V)
and
ConcurrentMap.merge(K, V, java.util.function.BiFunction<? super V, ? super V, ? extends V>)
.
This affects behaviour of ordinary map calls, as well as remote calls.public ChronicleMapBuilder<K,V> remoteOperations(MapRemoteOperations<K,V,?> remoteOperations)
Copyright © 2015. All rights reserved.