mirror of
https://github.com/OpenHFT/Chronicle-Map.git
synced 2021-09-13 01:26:12 +00:00
HCOLL-81 renamed ChronicleMap to ChronicleMapOnHeapUpdatableBuilder as Peter wanted the OffHeapUpdated Builder to be the default ChronicleMapBuilder.
This commit is contained in:
@@ -45,7 +45,7 @@ import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
/**
|
||||
* This interface defines the meaning of configurations, common to {@link ChronicleMapBuilder} and
|
||||
* This interface defines the meaning of configurations, common to {@link net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder} and
|
||||
* {@link ChronicleSetBuilder}, i. e. <i>Chronicle hash container</i> configurations.
|
||||
*
|
||||
* <p>{@code ChronicleHashBuilder} is mutable. Configuration methods mutate the builder and return
|
||||
@@ -56,7 +56,7 @@ import java.util.concurrent.TimeUnit;
|
||||
* @param <K> the type of keys in hash containers, created by this builder
|
||||
* @param <C> the container type, created by this builder, i. e. {@link ChronicleMap} or {@link
|
||||
* ChronicleSet}
|
||||
* @param <B> the concrete builder type, i. e. {@link ChronicleMapBuilder} or {@link
|
||||
* @param <B> the concrete builder type, i. e. {@link net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder} or {@link
|
||||
* ChronicleSetBuilder}
|
||||
*/
|
||||
public interface ChronicleHashBuilder<K, C extends ChronicleHash,
|
||||
@@ -130,7 +130,7 @@ public interface ChronicleHashBuilder<K, C extends ChronicleHash,
|
||||
*
|
||||
* <p>There are three major patterns of this configuration usage: <ol> <li>Key (and value, in
|
||||
* {@code ChronicleMap} case) sizes are constant. Configure them via {@link
|
||||
* #constantKeySizeBySample(Object)} and {@link ChronicleMapBuilder#constantValueSizeBySample(Object)}
|
||||
* #constantKeySizeBySample(Object)} and {@link net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder#constantValueSizeBySample(Object)}
|
||||
* methods, and you will experience no memory waste at all.</li> <li>Key (and/or value size, in
|
||||
* {@code ChronicleMap} case) varies moderately. Specify them using corresponding methods, or
|
||||
* specify entry size directly by calling this method, by sizes somewhere between average and
|
||||
@@ -154,7 +154,7 @@ public interface ChronicleHashBuilder<K, C extends ChronicleHash,
|
||||
* efficient manner, for example as {@code long[]} arrays. Typical number of connections is
|
||||
* 100-300, maximum is 3000. In this case entry size of
|
||||
* 50 * (8 bytes for each id) = 400 bytes would be a good choice: <pre>{@code
|
||||
* Map<Long, long[]> socialGraph = ChronicleMapBuilder
|
||||
* Map<Long, long[]> socialGraph = ChronicleMapOnHeapUpdatableBuilder
|
||||
* .of(Long.class, long[].class)
|
||||
* // given that graph should have of 1 billion nodes, and 150 average adjacency list size
|
||||
* // => values takes 3 chuncks on average
|
||||
@@ -183,7 +183,7 @@ public interface ChronicleHashBuilder<K, C extends ChronicleHash,
|
||||
* memory unit).</li> <li>If key (and/or value, in {@code ChronicleMap} case) size varies
|
||||
* moderately, you should pass to this method the maximum number of entries + 5-25%, depending
|
||||
* on your data properties and configured {@linkplain #keySize(int) key}/{@linkplain
|
||||
* ChronicleMapBuilder#valueSize(int) value}/{@linkplain #entrySize(int) entry} sizes.</li>
|
||||
* net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder#valueSize(int) value}/{@linkplain #entrySize(int) entry} sizes.</li>
|
||||
* <li>If your data size varies in a wide range, pass the maximum number of entries multiplied
|
||||
* by average data size and divided by the configured "entry size" (i. e. chunk size). See an
|
||||
* example in the documentation to {@link #entrySize(int)} method.</li> </ol>
|
||||
|
||||
@@ -57,19 +57,19 @@ import static net.openhft.chronicle.map.Objects.builderEquals;
|
||||
|
||||
/**
|
||||
* {@code AbstractChronicleMapBuilder} manages most of {@link ChronicleMap} configurations; has two concrete
|
||||
* subclasses: {@link ChronicleMapBuilder} should be used to create maps with ordinary values, {@link
|
||||
* OffHeapUpdatableChronicleMapBuilder} -- maps with {@link Byteable} values, which point directly to off-heap
|
||||
* subclasses: {@link ChronicleMapOnHeapUpdatableBuilder} should be used to create maps with ordinary values, {@link
|
||||
* ChronicleMapBuilder} -- maps with {@link Byteable} values, which point directly to off-heap
|
||||
* memory; could be used as a classic builder and/or factory. This means
|
||||
* that in addition to the standard builder usage pattern: <pre>{@code
|
||||
* ChronicleMap<Key, Value> map = ChronicleMapBuilder
|
||||
* ChronicleMap<Key, Value> map = ChronicleMapOnHeapUpdatableBuilder
|
||||
* .of(Key.class, Value.class)
|
||||
* .entries(100500)
|
||||
* // ... other configurations
|
||||
* .create();}</pre>
|
||||
* one of concrete {@code AbstractChronicleMapBuilder} subclasses, {@link ChronicleMapBuilder} or {@link
|
||||
* OffHeapUpdatableChronicleMapBuilder}, could be prepared and used to create many similar
|
||||
* one of concrete {@code AbstractChronicleMapBuilder} subclasses, {@link ChronicleMapOnHeapUpdatableBuilder} or {@link
|
||||
* ChronicleMapBuilder}, could be prepared and used to create many similar
|
||||
* maps: <pre>{@code
|
||||
* OffHeapUpdatableChronicleMapBuilder<Key, Value> builder = OffHeapUpdatableChronicleMapBuilder
|
||||
* ChronicleMapBuilder<Key, Value> builder = ChronicleMapBuilder
|
||||
* .of(Key.class, Value.class)
|
||||
* .entries(100500);
|
||||
*
|
||||
@@ -201,7 +201,7 @@ public abstract class AbstractChronicleMapBuilder<K, V,
|
||||
*
|
||||
* <p>Example: if keys in your map(s) are English words in {@link String} form, keys size 10
|
||||
* (a bit more than average English word length) would be a good choice: <pre>{@code
|
||||
* ChronicleMap<String, LongValue> wordFrequencies = OffHeapUpdatableChronicleMapBuilder
|
||||
* ChronicleMap<String, LongValue> wordFrequencies = ChronicleMapBuilder
|
||||
* .of(String.class, LongValue.class)
|
||||
* .entries(50000)
|
||||
* .keySize(10)
|
||||
@@ -227,7 +227,7 @@ public abstract class AbstractChronicleMapBuilder<K, V,
|
||||
*
|
||||
* <p>For example, if your keys are Git commit hashes:<pre>{@code
|
||||
* Map<byte[], String> gitCommitMessagesByHash =
|
||||
* ChronicleMapBuilder.of(byte[].class, String.class)
|
||||
* ChronicleMapOnHeapUpdatableBuilder.of(byte[].class, String.class)
|
||||
* .constantKeySizeBySample(new byte[20])
|
||||
* .create();}</pre>
|
||||
*
|
||||
@@ -532,7 +532,7 @@ public abstract class AbstractChronicleMapBuilder<K, V,
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "ChronicleMapBuilder{" +
|
||||
return "ChronicleMapOnHeapUpdatableBuilder{" +
|
||||
"actualSegments=" + pretty(actualSegments) +
|
||||
", minSegments=" + pretty(minSegments) +
|
||||
", actualEntriesPerSegment=" + pretty(actualEntriesPerSegment) +
|
||||
|
||||
@@ -23,7 +23,7 @@ import net.openhft.lang.io.Bytes;
|
||||
/**
|
||||
* Memory addresses alignment strategies.
|
||||
*
|
||||
* @see OffHeapUpdatableChronicleMapBuilder#entryAndValueAlignment(Alignment)
|
||||
* @see ChronicleMapBuilder#entryAndValueAlignment(Alignment)
|
||||
*/
|
||||
public enum Alignment {
|
||||
/**
|
||||
|
||||
@@ -93,7 +93,7 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
|
||||
* for the key
|
||||
* @see #get(Object)
|
||||
* @see #acquireUsing(Object, Object)
|
||||
* @see ChronicleMapBuilder#valueMarshaller(BytesMarshaller)
|
||||
* @see ChronicleMapOnHeapUpdatableBuilder#valueMarshaller(BytesMarshaller)
|
||||
*/
|
||||
V getUsing(K key, V usingValue);
|
||||
|
||||
@@ -134,7 +134,7 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
|
||||
* no mapping for the key
|
||||
* @see #get(Object)
|
||||
* @see #getUsing(Object, Object)
|
||||
* @see ChronicleMapBuilder#valueMarshaller(BytesMarshaller)
|
||||
* @see ChronicleMapOnHeapUpdatableBuilder#valueMarshaller(BytesMarshaller)
|
||||
*/
|
||||
@NotNull
|
||||
ReadContext<K, V> getUsingLocked(@NotNull K key, @NotNull V usingValue);
|
||||
@@ -166,8 +166,8 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
|
||||
* defaultValueProvider.}
|
||||
*
|
||||
* <p>If the {@code ChronicleMap} is off-heap updatable, i. e. created via {@link
|
||||
* OffHeapUpdatableChronicleMapBuilder} builder (values are {@link Byteable}), there is one more option of
|
||||
* what to do if the key is absent in the map, see {@link OffHeapUpdatableChronicleMapBuilder#prepareValueBytesOnAcquire(PrepareValueBytes)}.
|
||||
* ChronicleMapBuilder} builder (values are {@link Byteable}), there is one more option of
|
||||
* what to do if the key is absent in the map, see {@link ChronicleMapBuilder#prepareValueBytesOnAcquire(PrepareValueBytes)}.
|
||||
* By default, value bytes are just zeroed out, no default value, either provided for key or constant, is
|
||||
* put for the absent key.
|
||||
*
|
||||
|
||||
@@ -16,64 +16,31 @@
|
||||
|
||||
package net.openhft.chronicle.map;
|
||||
|
||||
import net.openhft.chronicle.hash.ChronicleHashBuilder;
|
||||
import net.openhft.chronicle.hash.serialization.*;
|
||||
import net.openhft.lang.io.Bytes;
|
||||
import net.openhft.lang.io.serialization.BytesMarshallable;
|
||||
import net.openhft.lang.io.serialization.BytesMarshaller;
|
||||
import net.openhft.lang.io.serialization.ObjectFactory;
|
||||
import net.openhft.lang.io.serialization.ObjectSerializer;
|
||||
import net.openhft.lang.model.Byteable;
|
||||
import net.openhft.lang.model.DataValueClasses;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import java.io.Externalizable;
|
||||
import java.io.Serializable;
|
||||
|
||||
|
||||
/**
|
||||
* {@code ChronicleMapBuilder} is intended to be used to configure {@link ChronicleMap}s with
|
||||
* non-{@link Byteable} values, which don't point to off-heap memory directly, including primitives
|
||||
* ({@link Long}, {@link Double}, etc.), {@link String}s and {@link CharSequence}s, values
|
||||
* implementing {@link BytesMarshallable}, {@link Externalizable} or {@link Serializable} interface,
|
||||
* or any other values for which {@linkplain #valueMarshaller(BytesMarshaller) custom marshaller}
|
||||
* is provided.
|
||||
*
|
||||
* <p>Use static {@link #of(Class, Class) of(Key.class, Value.class)} method to obtain
|
||||
* a {@code ChronicleMapBuilder} instance.
|
||||
*
|
||||
* @param <K> key type of the maps, created by this builder
|
||||
* @param <V> value type of the maps, created by this builder
|
||||
* @see OffHeapUpdatableChronicleMapBuilder
|
||||
* @see AbstractChronicleMapBuilder
|
||||
* @see ChronicleHashBuilder
|
||||
*/
|
||||
public final class ChronicleMapBuilder<K, V>
|
||||
extends AbstractChronicleMapBuilder<K, V, ChronicleMapBuilder<K, V>> {
|
||||
|
||||
/**
|
||||
* Returns a new {@code ChronicleMapBuilder} instance which is able to {@linkplain #create()
|
||||
* create} maps with the specified key and value classes.
|
||||
*
|
||||
* <p>{@code ChronicleMapBuilder} analyzes provided key and value classes and automatically
|
||||
* chooses the most specific and effective serializer which it is aware about. Read
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the section about
|
||||
* serialization in Chronicle Map manual</a> for more information.
|
||||
*
|
||||
* @param keyClass class object used to infer key type and discover it's properties
|
||||
* via reflection
|
||||
* @param valueClass class object used to infer value type and discover it's properties
|
||||
* via reflection
|
||||
* @param <K> key type of the maps, created by the returned builder
|
||||
* @param <V> value type of the maps, created by the returned builder
|
||||
* @return a new builder for the given key and value classes
|
||||
*/
|
||||
public static <K, V> ChronicleMapBuilder<K, V> of(
|
||||
@NotNull Class<K> keyClass, @NotNull Class<V> valueClass) {
|
||||
if (keyClass.isInterface() && keyClass != CharSequence.class) {
|
||||
keyClass = DataValueClasses.directClassFor(keyClass);
|
||||
}
|
||||
if (valueClass.isInterface()) {
|
||||
valueClass = DataValueClasses.directClassFor(valueClass);
|
||||
} else if (!offHeapReference(valueClass)) {
|
||||
throw new IllegalArgumentException(
|
||||
"Value class should be either Byteable subclass or interface," +
|
||||
"allowing direct Byteable implementation generation");
|
||||
}
|
||||
return new ChronicleMapBuilder<K, V>(keyClass, valueClass);
|
||||
}
|
||||
|
||||
ChronicleMapBuilder(Class<K> keyClass, Class<V> valueClass) {
|
||||
super(keyClass, valueClass);
|
||||
prepareValueBytesOnAcquire(new ZeroOutValueBytes<K, V>(valueSize()));
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -82,121 +49,52 @@ public final class ChronicleMapBuilder<K, V>
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
* {@inheritDoc} With respect to {@linkplain #entryAndValueAlignment(Alignment) alignment}.
|
||||
*
|
||||
* @see #constantKeySizeBySample(Object)
|
||||
* @see #valueSize(int)
|
||||
* @see #entrySize(int)
|
||||
* <p>Note that the actual entrySize will be aligned to 4 (default {@linkplain
|
||||
* #entryAndValueAlignment(Alignment) entry alignment}). I. e. if you set entry size to 30,
|
||||
* and entry alignment is set to {@link Alignment#OF_4_BYTES}, the actual entry size will be 32
|
||||
* (30 aligned to 4 bytes).
|
||||
*
|
||||
* @see #entryAndValueAlignment(Alignment)
|
||||
* @see #entries(long)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> keySize(int keySize) {
|
||||
return super.keySize(keySize);
|
||||
public ChronicleMapBuilder<K, V> entrySize(int entrySize) {
|
||||
return super.entrySize(entrySize);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
* 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.
|
||||
*
|
||||
* @see #keySize(int)
|
||||
* @see #constantValueSizeBySample(Object)
|
||||
* <p>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.
|
||||
*
|
||||
* <p>Note that {@linkplain #entrySize(int) entry size} will be aligned according to this
|
||||
* alignment. I. e. if you set {@code entrySize(20)} and {@link Alignment#OF_8_BYTES}, actual
|
||||
* entry size will be 24 (20 aligned to 8 bytes).
|
||||
*
|
||||
* <p>Default is {@link Alignment#OF_4_BYTES} for Byteable values.
|
||||
*
|
||||
* @param alignment the new alignment of the maps constructed by this builder
|
||||
* @return this {@code ChronicleMapOnHeapUpdatableBuilder} back
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> constantKeySizeBySample(K sampleKey) {
|
||||
return super.constantKeySizeBySample(sampleKey);
|
||||
public ChronicleMapBuilder<K, V> entryAndValueAlignment(Alignment alignment) {
|
||||
return super.entryAndValueAlignment(alignment);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the optimal number of bytes, taken by serialized form of values, put into maps,
|
||||
* created by this builder. If value size is always the same, call {@link
|
||||
* #constantValueSizeBySample(Object)} method instead of this one.
|
||||
* {@inheritDoc} Also, it overrides any previous {@link #prepareValueBytesOnAcquire}
|
||||
* configuration to this {@code ChronicleMapBuilder}.
|
||||
*
|
||||
* <p>If value is a boxed primitive type, i. e. if value size is known statically,
|
||||
* it is automatically accounted and shouldn't be specified by user.
|
||||
*
|
||||
* <p>If value size varies moderately, specify the size higher than average, but lower than the
|
||||
* maximum possible, to minimize average memory overuse. If value size varies in a wide range,
|
||||
* it's better to use {@linkplain #entrySize(int) entry size} in "chunk" mode and configure it
|
||||
* directly.
|
||||
*
|
||||
* @param valueSize number of bytes, taken by serialized form of values
|
||||
* @return this {@code ChronicleMapBuilder} back
|
||||
* @see #constantValueSizeBySample(Object)
|
||||
* @see #keySize(int)
|
||||
* @see #entrySize(int)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> valueSize(int valueSize) {
|
||||
return super.valueSize(valueSize);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the constant number of bytes, taken by serialized form of values, put into maps,
|
||||
* created by this builder. This is done by providing the {@code sampleValue}, all values should
|
||||
* take the same number of bytes in serialized form, as this sample object.
|
||||
*
|
||||
* <p>If values are of boxed primitive type or {@link Byteable} subclass, i. e. if value size is
|
||||
* known statically, it is automatically accounted and this method shouldn't be called.
|
||||
*
|
||||
* <p>If value size varies, method {@link #valueSize(int)} or {@link #entrySize(int)} should be
|
||||
* called instead of this one.
|
||||
*
|
||||
* @param sampleValue the sample value
|
||||
* @return this builder back
|
||||
* @see #valueSize(int)
|
||||
* @see #constantKeySizeBySample(Object)
|
||||
*/
|
||||
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> constantValueSizeBySample(
|
||||
@NotNull V sampleValue) {
|
||||
return super.constantValueSizeBySample(sampleValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>Example: <pre>{@code Map<Key, Value> map =
|
||||
* ChronicleMapBuilder.of(Key.class, Value.class)
|
||||
* .entries(1_000_000)
|
||||
* .keySize(50).valueSize(200)
|
||||
* // this class hasn't implemented yet, just for example
|
||||
* .objectSerializer(new KryoObjectSerializer())
|
||||
* .create();}</pre>
|
||||
*
|
||||
* <p>This serializer is used to serialize both keys and values, if they both require this:
|
||||
* loosely typed, nullable, and custom {@linkplain #keyMarshaller(BytesMarshaller) key} and
|
||||
* {@linkplain #valueMarshaller(BytesMarshaller) value} marshallers are not configured.
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> objectSerializer(
|
||||
@NotNull ObjectSerializer objectSerializer) {
|
||||
return super.objectSerializer(objectSerializer);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>If {@linkplain #valueMarshaller(BytesMarshaller) custom value marshaller} is configured,
|
||||
* this configuration is unused, because it is incapsulated in {@link
|
||||
* BytesMarshaller#read(Bytes)} method (without provided instance to read the data into),
|
||||
* i. e. it's is the user-side responsibility. Actually this is just a convenience method
|
||||
* supporting value marshaller configurations, made initially during {@link #of(Class, Class)}
|
||||
* call, if the value class is {@link BytesMarshallable} or {@link Externalizable} subclass.
|
||||
*
|
||||
* @throws IllegalStateException if custom value marshaller is specified or value class is not
|
||||
* either {@code BytesMarshallable} or {@code Externalizable}
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> valueDeserializationFactory(
|
||||
@NotNull ObjectFactory<V> valueDeserializationFactory) {
|
||||
return super.valueDeserializationFactory(valueDeserializationFactory);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>By default, the default value is set to {@code null}.
|
||||
* <p>By default, the default value is not specified, default {@linkplain
|
||||
* #prepareValueBytesOnAcquire prepare value bytes routine} is specified instead.
|
||||
*
|
||||
* @see #defaultValueProvider(DefaultValueProvider)
|
||||
* @see #prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> defaultValue(V defaultValue) {
|
||||
@@ -204,12 +102,14 @@ public final class ChronicleMapBuilder<K, V>
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
* {@inheritDoc} Also, it overrides any previous {@link #prepareValueBytesOnAcquire}
|
||||
* configuration to this {@code ChronicleMapBuilder}.
|
||||
*
|
||||
* <p>By default, default value provider is not specified, {@link #defaultValue(Object) default
|
||||
* value} is specified instead.
|
||||
* <p>By default, the default value provider is not specified, default {@linkplain
|
||||
* #prepareValueBytesOnAcquire prepare value bytes routine} is specified instead.
|
||||
*
|
||||
* @see #defaultValue(Object)
|
||||
* @see #prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> defaultValueProvider(
|
||||
@@ -218,67 +118,23 @@ public final class ChronicleMapBuilder<K, V>
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the {@code BytesMarshaller} used to serialize/deserialize values to/from off-heap
|
||||
* memory in maps, created by this builder. See
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the
|
||||
* section about serialization in ChronicleMap manual</a> for more information.
|
||||
* Configures the procedure which is called on the bytes, which later the returned value is
|
||||
* pointing to, if the key is absent, on {@link ChronicleMap#acquireUsing(Object, Object)
|
||||
* acquireUsing()} call on maps, created by this builder. See {@link PrepareValueBytes} for
|
||||
* more information.
|
||||
*
|
||||
* @param valueMarshaller the marshaller used to serialize values
|
||||
* <p>The default preparation callback zeroes out the value bytes.
|
||||
*
|
||||
* @param prepareValueBytes what to do with the value bytes before assigning them into the
|
||||
* {@link Byteable} value to return from {@code acquireUsing()} call
|
||||
* @return this builder back
|
||||
* @see #valueMarshallers(BytesWriter, BytesReader)
|
||||
* @see OffHeapUpdatableChronicleMapBuilder
|
||||
* @see #objectSerializer(ObjectSerializer)
|
||||
* @see PrepareValueBytes
|
||||
* @see #defaultValue(Object)
|
||||
* @see #defaultValueProvider(DefaultValueProvider)
|
||||
*/
|
||||
public ChronicleMapBuilder<K, V> valueMarshaller(
|
||||
@NotNull BytesMarshaller<V> valueMarshaller) {
|
||||
valueBuilder.marshaller(valueMarshaller);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the marshallers, used to serialize/deserialize values to/from off-heap
|
||||
* memory in maps, created by this builder. See
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the section about
|
||||
* serialization in ChronicleMap manual</a> for more information.
|
||||
*
|
||||
* <p>Configuring marshalling this way results to a little bit more compact in-memory layout
|
||||
* of the map, comparing to a single interface configuration:
|
||||
* {@link #valueMarshaller(BytesMarshaller)}.
|
||||
*
|
||||
* <p>Passing {@link BytesInterop} instead of plain {@link BytesWriter} is, of cause, possible,
|
||||
* but currently pointless for values.
|
||||
*
|
||||
* @param valueWriter the new value object → {@link Bytes} writer (interop) strategy
|
||||
* @param valueReader the new {@link Bytes} → value object reader strategy
|
||||
* @return this builder back
|
||||
* @see #valueMarshaller(BytesMarshaller)
|
||||
*/
|
||||
public ChronicleMapBuilder<K, V> valueMarshallers(
|
||||
@NotNull BytesWriter<V> valueWriter, @NotNull BytesReader<V> valueReader) {
|
||||
valueBuilder.writer(valueWriter);
|
||||
valueBuilder.reader(valueReader);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the marshaller used to serialize actual value sizes to off-heap memory in maps,
|
||||
* created by this builder.
|
||||
*
|
||||
* <p>Default value size marshaller is so-called {@linkplain SizeMarshallers#stopBit()
|
||||
* stop bit encoding marshalling}. If {@linkplain #constantValueSizeBySample(Object) constant
|
||||
* value size} is configured, or defaulted if the value type is always constant and {@code
|
||||
* ChronicleHashBuilder} implementation knows about it, this configuration takes no effect,
|
||||
* because a special {@link SizeMarshaller} implementation, which doesn't actually do any
|
||||
* marshalling, and just returns the known constant size on {@link SizeMarshaller#readSize(
|
||||
* Bytes)} calls, is used instead of any {@code SizeMarshaller} configured using this method.
|
||||
*
|
||||
* @param valueSizeMarshaller the new marshaller, used to serialize actual value sizes to
|
||||
* off-heap memory
|
||||
* @return this builder back
|
||||
*/
|
||||
public ChronicleMapBuilder<K, V> valueSizeMarshaller(
|
||||
@NotNull SizeMarshaller valueSizeMarshaller) {
|
||||
valueBuilder.sizeMarshaller(valueSizeMarshaller);
|
||||
return this;
|
||||
@Override
|
||||
public ChronicleMapBuilder<K, V> prepareValueBytesOnAcquire(
|
||||
@NotNull PrepareValueBytes<K, V> prepareValueBytes) {
|
||||
return super.prepareValueBytesOnAcquire(prepareValueBytes);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,284 @@
|
||||
/*
|
||||
* Copyright 2014 Higher Frequency Trading http://www.higherfrequencytrading.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package net.openhft.chronicle.map;
|
||||
|
||||
import net.openhft.chronicle.hash.ChronicleHashBuilder;
|
||||
import net.openhft.chronicle.hash.serialization.*;
|
||||
import net.openhft.lang.io.Bytes;
|
||||
import net.openhft.lang.io.serialization.BytesMarshallable;
|
||||
import net.openhft.lang.io.serialization.BytesMarshaller;
|
||||
import net.openhft.lang.io.serialization.ObjectFactory;
|
||||
import net.openhft.lang.io.serialization.ObjectSerializer;
|
||||
import net.openhft.lang.model.Byteable;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
import java.io.Externalizable;
|
||||
import java.io.Serializable;
|
||||
|
||||
|
||||
/**
|
||||
* {@code ChronicleMapOnHeapUpdatableBuilder} is intended to be used to configure {@link ChronicleMap}s with
|
||||
* non-{@link Byteable} values, which don't point to off-heap memory directly, including primitives
|
||||
* ({@link Long}, {@link Double}, etc.), {@link String}s and {@link CharSequence}s, values
|
||||
* implementing {@link BytesMarshallable}, {@link Externalizable} or {@link Serializable} interface,
|
||||
* or any other values for which {@linkplain #valueMarshaller(BytesMarshaller) custom marshaller}
|
||||
* is provided.
|
||||
*
|
||||
* <p>Use static {@link #of(Class, Class) of(Key.class, Value.class)} method to obtain
|
||||
* a {@code ChronicleMapOnHeapUpdatableBuilder} instance.
|
||||
*
|
||||
* @param <K> key type of the maps, created by this builder
|
||||
* @param <V> value type of the maps, created by this builder
|
||||
* @see ChronicleMapBuilder
|
||||
* @see AbstractChronicleMapBuilder
|
||||
* @see ChronicleHashBuilder
|
||||
*/
|
||||
public final class ChronicleMapOnHeapUpdatableBuilder<K, V>
|
||||
extends AbstractChronicleMapBuilder<K, V, ChronicleMapOnHeapUpdatableBuilder<K, V>> {
|
||||
|
||||
/**
|
||||
* Returns a new {@code ChronicleMapOnHeapUpdatableBuilder} instance which is able to {@linkplain #create()
|
||||
* create} maps with the specified key and value classes.
|
||||
*
|
||||
* <p>{@code ChronicleMapOnHeapUpdatableBuilder} analyzes provided key and value classes and automatically
|
||||
* chooses the most specific and effective serializer which it is aware about. Read
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the section about
|
||||
* serialization in Chronicle Map manual</a> for more information.
|
||||
*
|
||||
* @param keyClass class object used to infer key type and discover it's properties
|
||||
* via reflection
|
||||
* @param valueClass class object used to infer value type and discover it's properties
|
||||
* via reflection
|
||||
* @param <K> key type of the maps, created by the returned builder
|
||||
* @param <V> value type of the maps, created by the returned builder
|
||||
* @return a new builder for the given key and value classes
|
||||
*/
|
||||
public static <K, V> ChronicleMapOnHeapUpdatableBuilder<K, V> of(
|
||||
@NotNull Class<K> keyClass, @NotNull Class<V> valueClass) {
|
||||
return new ChronicleMapOnHeapUpdatableBuilder<K, V>(keyClass, valueClass);
|
||||
}
|
||||
|
||||
ChronicleMapOnHeapUpdatableBuilder(Class<K> keyClass, Class<V> valueClass) {
|
||||
super(keyClass, valueClass);
|
||||
}
|
||||
|
||||
@Override
|
||||
ChronicleMapOnHeapUpdatableBuilder<K, V> self() {
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @see #constantKeySizeBySample(Object)
|
||||
* @see #valueSize(int)
|
||||
* @see #entrySize(int)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> keySize(int keySize) {
|
||||
return super.keySize(keySize);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @see #keySize(int)
|
||||
* @see #constantValueSizeBySample(Object)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> constantKeySizeBySample(K sampleKey) {
|
||||
return super.constantKeySizeBySample(sampleKey);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the optimal number of bytes, taken by serialized form of values, put into maps,
|
||||
* created by this builder. If value size is always the same, call {@link
|
||||
* #constantValueSizeBySample(Object)} method instead of this one.
|
||||
*
|
||||
* <p>If value is a boxed primitive type, i. e. if value size is known statically,
|
||||
* it is automatically accounted and shouldn't be specified by user.
|
||||
*
|
||||
* <p>If value size varies moderately, specify the size higher than average, but lower than the
|
||||
* maximum possible, to minimize average memory overuse. If value size varies in a wide range,
|
||||
* it's better to use {@linkplain #entrySize(int) entry size} in "chunk" mode and configure it
|
||||
* directly.
|
||||
*
|
||||
* @param valueSize number of bytes, taken by serialized form of values
|
||||
* @return this {@code ChronicleMapOnHeapUpdatableBuilder} back
|
||||
* @see #constantValueSizeBySample(Object)
|
||||
* @see #keySize(int)
|
||||
* @see #entrySize(int)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> valueSize(int valueSize) {
|
||||
return super.valueSize(valueSize);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the constant number of bytes, taken by serialized form of values, put into maps,
|
||||
* created by this builder. This is done by providing the {@code sampleValue}, all values should
|
||||
* take the same number of bytes in serialized form, as this sample object.
|
||||
*
|
||||
* <p>If values are of boxed primitive type or {@link Byteable} subclass, i. e. if value size is
|
||||
* known statically, it is automatically accounted and this method shouldn't be called.
|
||||
*
|
||||
* <p>If value size varies, method {@link #valueSize(int)} or {@link #entrySize(int)} should be
|
||||
* called instead of this one.
|
||||
*
|
||||
* @param sampleValue the sample value
|
||||
* @return this builder back
|
||||
* @see #valueSize(int)
|
||||
* @see #constantKeySizeBySample(Object)
|
||||
*/
|
||||
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> constantValueSizeBySample(
|
||||
@NotNull V sampleValue) {
|
||||
return super.constantValueSizeBySample(sampleValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>Example: <pre>{@code Map<Key, Value> map =
|
||||
* ChronicleMapOnHeapUpdatableBuilder.of(Key.class, Value.class)
|
||||
* .entries(1_000_000)
|
||||
* .keySize(50).valueSize(200)
|
||||
* // this class hasn't implemented yet, just for example
|
||||
* .objectSerializer(new KryoObjectSerializer())
|
||||
* .create();}</pre>
|
||||
*
|
||||
* <p>This serializer is used to serialize both keys and values, if they both require this:
|
||||
* loosely typed, nullable, and custom {@linkplain #keyMarshaller(BytesMarshaller) key} and
|
||||
* {@linkplain #valueMarshaller(BytesMarshaller) value} marshallers are not configured.
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> objectSerializer(
|
||||
@NotNull ObjectSerializer objectSerializer) {
|
||||
return super.objectSerializer(objectSerializer);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>If {@linkplain #valueMarshaller(BytesMarshaller) custom value marshaller} is configured,
|
||||
* this configuration is unused, because it is incapsulated in {@link
|
||||
* BytesMarshaller#read(Bytes)} method (without provided instance to read the data into),
|
||||
* i. e. it's is the user-side responsibility. Actually this is just a convenience method
|
||||
* supporting value marshaller configurations, made initially during {@link #of(Class, Class)}
|
||||
* call, if the value class is {@link BytesMarshallable} or {@link Externalizable} subclass.
|
||||
*
|
||||
* @throws IllegalStateException if custom value marshaller is specified or value class is not
|
||||
* either {@code BytesMarshallable} or {@code Externalizable}
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> valueDeserializationFactory(
|
||||
@NotNull ObjectFactory<V> valueDeserializationFactory) {
|
||||
return super.valueDeserializationFactory(valueDeserializationFactory);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>By default, the default value is set to {@code null}.
|
||||
*
|
||||
* @see #defaultValueProvider(DefaultValueProvider)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> defaultValue(V defaultValue) {
|
||||
return super.defaultValue(defaultValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* <p>By default, default value provider is not specified, {@link #defaultValue(Object) default
|
||||
* value} is specified instead.
|
||||
*
|
||||
* @see #defaultValue(Object)
|
||||
*/
|
||||
@Override
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> defaultValueProvider(
|
||||
@NotNull DefaultValueProvider<K, V> defaultValueProvider) {
|
||||
return super.defaultValueProvider(defaultValueProvider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the {@code BytesMarshaller} used to serialize/deserialize values to/from off-heap
|
||||
* memory in maps, created by this builder. See
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the
|
||||
* section about serialization in ChronicleMap manual</a> for more information.
|
||||
*
|
||||
* @param valueMarshaller the marshaller used to serialize values
|
||||
* @return this builder back
|
||||
* @see #valueMarshallers(BytesWriter, BytesReader)
|
||||
* @see ChronicleMapBuilder
|
||||
* @see #objectSerializer(ObjectSerializer)
|
||||
*/
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> valueMarshaller(
|
||||
@NotNull BytesMarshaller<V> valueMarshaller) {
|
||||
valueBuilder.marshaller(valueMarshaller);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the marshallers, used to serialize/deserialize values to/from off-heap
|
||||
* memory in maps, created by this builder. See
|
||||
* <a href="https://github.com/OpenHFT/Chronicle-Map#serialization">the section about
|
||||
* serialization in ChronicleMap manual</a> for more information.
|
||||
*
|
||||
* <p>Configuring marshalling this way results to a little bit more compact in-memory layout
|
||||
* of the map, comparing to a single interface configuration:
|
||||
* {@link #valueMarshaller(BytesMarshaller)}.
|
||||
*
|
||||
* <p>Passing {@link BytesInterop} instead of plain {@link BytesWriter} is, of cause, possible,
|
||||
* but currently pointless for values.
|
||||
*
|
||||
* @param valueWriter the new value object → {@link Bytes} writer (interop) strategy
|
||||
* @param valueReader the new {@link Bytes} → value object reader strategy
|
||||
* @return this builder back
|
||||
* @see #valueMarshaller(BytesMarshaller)
|
||||
*/
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> valueMarshallers(
|
||||
@NotNull BytesWriter<V> valueWriter, @NotNull BytesReader<V> valueReader) {
|
||||
valueBuilder.writer(valueWriter);
|
||||
valueBuilder.reader(valueReader);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the marshaller used to serialize actual value sizes to off-heap memory in maps,
|
||||
* created by this builder.
|
||||
*
|
||||
* <p>Default value size marshaller is so-called {@linkplain SizeMarshallers#stopBit()
|
||||
* stop bit encoding marshalling}. If {@linkplain #constantValueSizeBySample(Object) constant
|
||||
* value size} is configured, or defaulted if the value type is always constant and {@code
|
||||
* ChronicleHashBuilder} implementation knows about it, this configuration takes no effect,
|
||||
* because a special {@link SizeMarshaller} implementation, which doesn't actually do any
|
||||
* marshalling, and just returns the known constant size on {@link SizeMarshaller#readSize(
|
||||
* Bytes)} calls, is used instead of any {@code SizeMarshaller} configured using this method.
|
||||
*
|
||||
* @param valueSizeMarshaller the new marshaller, used to serialize actual value sizes to
|
||||
* off-heap memory
|
||||
* @return this builder back
|
||||
*/
|
||||
public ChronicleMapOnHeapUpdatableBuilder<K, V> valueSizeMarshaller(
|
||||
@NotNull SizeMarshaller valueSizeMarshaller) {
|
||||
valueBuilder.sizeMarshaller(valueSizeMarshaller);
|
||||
return this;
|
||||
}
|
||||
}
|
||||
@@ -231,7 +231,7 @@ public class NodeDiscovery {
|
||||
LOG.info("Using Remote identifier=" + identifier);
|
||||
nodeDiscoveryEventListenerAtomicReference.set(null);
|
||||
|
||||
return ChronicleMapBuilder.of(Integer.class,
|
||||
return ChronicleMapOnHeapUpdatableBuilder.of(Integer.class,
|
||||
CharSequence.class)
|
||||
.entries(20000L)
|
||||
.replication(SingleChronicleHashReplication.builder()
|
||||
|
||||
@@ -1,140 +0,0 @@
|
||||
/*
|
||||
* Copyright 2014 Higher Frequency Trading http://www.higherfrequencytrading.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package net.openhft.chronicle.map;
|
||||
|
||||
import net.openhft.lang.model.Byteable;
|
||||
import net.openhft.lang.model.DataValueClasses;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
public final class OffHeapUpdatableChronicleMapBuilder<K, V>
|
||||
extends AbstractChronicleMapBuilder<K, V, OffHeapUpdatableChronicleMapBuilder<K, V>> {
|
||||
|
||||
public static <K, V> OffHeapUpdatableChronicleMapBuilder<K, V> of(
|
||||
@NotNull Class<K> keyClass, @NotNull Class<V> valueClass) {
|
||||
if (keyClass.isInterface() && keyClass != CharSequence.class) {
|
||||
keyClass = DataValueClasses.directClassFor(keyClass);
|
||||
}
|
||||
if (valueClass.isInterface()) {
|
||||
valueClass = DataValueClasses.directClassFor(valueClass);
|
||||
} else if (!offHeapReference(valueClass)) {
|
||||
throw new IllegalArgumentException(
|
||||
"Value class should be either Byteable subclass or interface," +
|
||||
"allowing direct Byteable implementation generation");
|
||||
}
|
||||
return new OffHeapUpdatableChronicleMapBuilder<K, V>(keyClass, valueClass);
|
||||
}
|
||||
|
||||
OffHeapUpdatableChronicleMapBuilder(Class<K> keyClass, Class<V> valueClass) {
|
||||
super(keyClass, valueClass);
|
||||
prepareValueBytesOnAcquire(new ZeroOutValueBytes<K, V>(valueSize()));
|
||||
}
|
||||
|
||||
@Override
|
||||
OffHeapUpdatableChronicleMapBuilder<K, V> self() {
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc} With respect to {@linkplain #entryAndValueAlignment(Alignment) alignment}.
|
||||
*
|
||||
* <p>Note that the actual entrySize will be aligned to 4 (default {@linkplain
|
||||
* #entryAndValueAlignment(Alignment) entry alignment}). I. e. if you set entry size to 30,
|
||||
* and entry alignment is set to {@link Alignment#OF_4_BYTES}, the actual entry size will be 32
|
||||
* (30 aligned to 4 bytes).
|
||||
*
|
||||
* @see #entryAndValueAlignment(Alignment)
|
||||
* @see #entries(long)
|
||||
*/
|
||||
@Override
|
||||
public OffHeapUpdatableChronicleMapBuilder<K, V> entrySize(int entrySize) {
|
||||
return super.entrySize(entrySize);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* <p>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.
|
||||
*
|
||||
* <p>Note that {@linkplain #entrySize(int) entry size} will be aligned according to this
|
||||
* alignment. I. e. if you set {@code entrySize(20)} and {@link Alignment#OF_8_BYTES}, actual
|
||||
* entry size will be 24 (20 aligned to 8 bytes).
|
||||
*
|
||||
* <p>Default is {@link Alignment#OF_4_BYTES} for Byteable values.
|
||||
*
|
||||
* @param alignment the new alignment of the maps constructed by this builder
|
||||
* @return this {@code ChronicleMapBuilder} back
|
||||
*/
|
||||
@Override
|
||||
public OffHeapUpdatableChronicleMapBuilder<K, V> entryAndValueAlignment(Alignment alignment) {
|
||||
return super.entryAndValueAlignment(alignment);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc} Also, it overrides any previous {@link #prepareValueBytesOnAcquire}
|
||||
* configuration to this {@code OffHeapUpdatableChronicleMapBuilder}.
|
||||
*
|
||||
* <p>By default, the default value is not specified, default {@linkplain
|
||||
* #prepareValueBytesOnAcquire prepare value bytes routine} is specified instead.
|
||||
*
|
||||
* @see #defaultValueProvider(DefaultValueProvider)
|
||||
* @see #prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
*/
|
||||
@Override
|
||||
public OffHeapUpdatableChronicleMapBuilder<K, V> defaultValue(V defaultValue) {
|
||||
return super.defaultValue(defaultValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc} Also, it overrides any previous {@link #prepareValueBytesOnAcquire}
|
||||
* configuration to this {@code OffHeapUpdatableChronicleMapBuilder}.
|
||||
*
|
||||
* <p>By default, the default value provider is not specified, default {@linkplain
|
||||
* #prepareValueBytesOnAcquire prepare value bytes routine} is specified instead.
|
||||
*
|
||||
* @see #defaultValue(Object)
|
||||
* @see #prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
*/
|
||||
@Override
|
||||
public OffHeapUpdatableChronicleMapBuilder<K, V> defaultValueProvider(
|
||||
@NotNull DefaultValueProvider<K, V> defaultValueProvider) {
|
||||
return super.defaultValueProvider(defaultValueProvider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the procedure which is called on the bytes, which later the returned value is
|
||||
* pointing to, if the key is absent, on {@link ChronicleMap#acquireUsing(Object, Object)
|
||||
* acquireUsing()} call on maps, created by this builder. See {@link PrepareValueBytes} for
|
||||
* more information.
|
||||
*
|
||||
* <p>The default preparation callback zeroes out the value bytes.
|
||||
*
|
||||
* @param prepareValueBytes what to do with the value bytes before assigning them into the
|
||||
* {@link Byteable} value to return from {@code acquireUsing()} call
|
||||
* @return this builder back
|
||||
* @see PrepareValueBytes
|
||||
* @see #defaultValue(Object)
|
||||
* @see #defaultValueProvider(DefaultValueProvider)
|
||||
*/
|
||||
@Override
|
||||
public OffHeapUpdatableChronicleMapBuilder<K, V> prepareValueBytesOnAcquire(
|
||||
@NotNull PrepareValueBytes<K, V> prepareValueBytes) {
|
||||
return super.prepareValueBytesOnAcquire(prepareValueBytes);
|
||||
}
|
||||
}
|
||||
@@ -26,11 +26,11 @@ import java.io.Serializable;
|
||||
* value during {@link ChronicleMap#acquireUsing(Object, Object)
|
||||
* chronicleMap.acquireUsing()} call, when the given key is absent in the map. Example: if you
|
||||
* want {@code 1L} to be the off-heap updatable ChronicleMap's {@linkplain
|
||||
* OffHeapUpdatableChronicleMapBuilder#defaultValue(Object) default value}, the most simple way
|
||||
* to achieve this is to {@linkplain OffHeapUpdatableChronicleMapBuilder#prepareValueBytesOnAcquire(
|
||||
* ChronicleMapBuilder#defaultValue(Object) default value}, the most simple way
|
||||
* to achieve this is to {@linkplain ChronicleMapBuilder#prepareValueBytesOnAcquire(
|
||||
* PrepareValueBytes) configure} custom {@code PrepareValueBytes} strategy in {@link
|
||||
* OffHeapUpdatableChronicleMapBuilder}: <pre>{@code
|
||||
* OffHeapUpdatableChronicleMapBuilder.of(Key.class, LongValue.class)
|
||||
* ChronicleMapBuilder}: <pre>{@code
|
||||
* ChronicleMapBuilder.of(Key.class, LongValue.class)
|
||||
* .prepareValueBytesOnAcquire((bytes, k) -> bytes.writeLong(1L))
|
||||
* ...
|
||||
* .create();}</pre>
|
||||
@@ -41,7 +41,7 @@ import java.io.Serializable;
|
||||
*
|
||||
* @param <K> the key type of {@link ChronicleMap}, on which {@code acquireUsing()} is queried
|
||||
* @param <V> the value type of {@link ChronicleMap}, on which {@code acquireUsing()} is queried
|
||||
* @see OffHeapUpdatableChronicleMapBuilder#prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
* @see ChronicleMapBuilder#prepareValueBytesOnAcquire(PrepareValueBytes)
|
||||
*/
|
||||
public interface PrepareValueBytes<K, V> extends Serializable {
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ import net.openhft.chronicle.hash.serialization.BytesReader;
|
||||
import net.openhft.chronicle.hash.serialization.BytesWriter;
|
||||
import net.openhft.chronicle.hash.serialization.SizeMarshaller;
|
||||
import net.openhft.chronicle.map.ChronicleMap;
|
||||
import net.openhft.chronicle.map.ChronicleMapBuilder;
|
||||
import net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder;
|
||||
import net.openhft.lang.io.serialization.BytesMarshaller;
|
||||
import net.openhft.lang.io.serialization.BytesMarshallerFactory;
|
||||
import net.openhft.lang.io.serialization.ObjectFactory;
|
||||
@@ -45,20 +45,20 @@ import java.util.concurrent.TimeUnit;
|
||||
* {@code ChronicleSetBuilder} manages the whole set of {@link ChronicleSet} configurations, could be used as
|
||||
* a classic builder and/or factory.
|
||||
*
|
||||
* <p>{@code ChronicleMapBuilder} is mutable, see a note in {@link ChronicleHashBuilder} interface
|
||||
* <p>{@code ChronicleMapOnHeapUpdatableBuilder} is mutable, see a note in {@link ChronicleHashBuilder} interface
|
||||
* documentation.
|
||||
*
|
||||
* @param <E> element type of the sets, created by this builder
|
||||
* @see ChronicleSet
|
||||
* @see ChronicleMapBuilder
|
||||
* @see net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder
|
||||
*/
|
||||
public class ChronicleSetBuilder<E>
|
||||
implements ChronicleHashBuilder<E, ChronicleSet<E>, ChronicleSetBuilder<E>> {
|
||||
|
||||
private ChronicleMapBuilder<E, DummyValue> chronicleMapBuilder;
|
||||
private ChronicleMapOnHeapUpdatableBuilder<E, DummyValue> chronicleMapBuilderOnHeap;
|
||||
|
||||
ChronicleSetBuilder(Class<E> keyClass) {
|
||||
chronicleMapBuilder = ChronicleMapBuilder.of(keyClass, DummyValue.class)
|
||||
chronicleMapBuilderOnHeap = ChronicleMapOnHeapUpdatableBuilder.of(keyClass, DummyValue.class)
|
||||
.valueMarshallers(DummyValueMarshaller.INSTANCE, DummyValueMarshaller.INSTANCE)
|
||||
.valueSizeMarshaller(DummyValueMarshaller.INSTANCE);
|
||||
}
|
||||
@@ -72,7 +72,7 @@ public class ChronicleSetBuilder<E>
|
||||
try {
|
||||
@SuppressWarnings("unchecked")
|
||||
final ChronicleSetBuilder<E> result = (ChronicleSetBuilder<E>) super.clone();
|
||||
result.chronicleMapBuilder = chronicleMapBuilder.clone();
|
||||
result.chronicleMapBuilderOnHeap = chronicleMapBuilderOnHeap.clone();
|
||||
return result;
|
||||
} catch (CloneNotSupportedException e) {
|
||||
throw new AssertionError(e);
|
||||
@@ -81,19 +81,19 @@ public class ChronicleSetBuilder<E>
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> actualSegments(int actualSegments) {
|
||||
chronicleMapBuilder.actualSegments(actualSegments);
|
||||
chronicleMapBuilderOnHeap.actualSegments(actualSegments);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> minSegments(int minSegments) {
|
||||
chronicleMapBuilder.minSegments(minSegments);
|
||||
chronicleMapBuilderOnHeap.minSegments(minSegments);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> actualEntriesPerSegment(long actualEntriesPerSegment) {
|
||||
chronicleMapBuilder.actualEntriesPerSegment(actualEntriesPerSegment);
|
||||
chronicleMapBuilderOnHeap.actualEntriesPerSegment(actualEntriesPerSegment);
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -116,7 +116,7 @@ public class ChronicleSetBuilder<E>
|
||||
*/
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> keySize(int keySize) {
|
||||
chronicleMapBuilder.keySize(keySize);
|
||||
chronicleMapBuilderOnHeap.keySize(keySize);
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -132,7 +132,7 @@ public class ChronicleSetBuilder<E>
|
||||
*/
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> constantKeySizeBySample(E sampleKey) {
|
||||
chronicleMapBuilder.constantKeySizeBySample(sampleKey);
|
||||
chronicleMapBuilderOnHeap.constantKeySizeBySample(sampleKey);
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -149,38 +149,38 @@ public class ChronicleSetBuilder<E>
|
||||
*/
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> entrySize(int entrySize) {
|
||||
chronicleMapBuilder.entrySize(entrySize);
|
||||
chronicleMapBuilderOnHeap.entrySize(entrySize);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> entries(long entries) {
|
||||
chronicleMapBuilder.entries(entries);
|
||||
chronicleMapBuilderOnHeap.entries(entries);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> lockTimeOut(long lockTimeOut, TimeUnit unit) {
|
||||
chronicleMapBuilder.lockTimeOut(lockTimeOut, unit);
|
||||
chronicleMapBuilderOnHeap.lockTimeOut(lockTimeOut, unit);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> errorListener(ChronicleHashErrorListener errorListener) {
|
||||
chronicleMapBuilder.errorListener(errorListener);
|
||||
chronicleMapBuilderOnHeap.errorListener(errorListener);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> metaDataBytes(int metaDataBytes) {
|
||||
chronicleMapBuilder.metaDataBytes(metaDataBytes);
|
||||
chronicleMapBuilderOnHeap.metaDataBytes(metaDataBytes);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return " ChronicleSetBuilder{" +
|
||||
"chronicleMapBuilder=" + chronicleMapBuilder +
|
||||
"chronicleMapBuilderOnHeap=" + chronicleMapBuilderOnHeap +
|
||||
'}';
|
||||
}
|
||||
|
||||
@@ -189,7 +189,7 @@ public class ChronicleSetBuilder<E>
|
||||
public boolean equals(Object o) {
|
||||
if (!(o instanceof ChronicleSetBuilder))
|
||||
return false;
|
||||
return chronicleMapBuilder.equals(((ChronicleSetBuilder) o).chronicleMapBuilder);
|
||||
return chronicleMapBuilderOnHeap.equals(((ChronicleSetBuilder) o).chronicleMapBuilderOnHeap);
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -199,14 +199,14 @@ public class ChronicleSetBuilder<E>
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> timeProvider(TimeProvider timeProvider) {
|
||||
chronicleMapBuilder.timeProvider(timeProvider);
|
||||
chronicleMapBuilderOnHeap.timeProvider(timeProvider);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> bytesMarshallerFactory(
|
||||
BytesMarshallerFactory bytesMarshallerFactory) {
|
||||
chronicleMapBuilder.bytesMarshallerFactory(bytesMarshallerFactory);
|
||||
chronicleMapBuilderOnHeap.bytesMarshallerFactory(bytesMarshallerFactory);
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -222,26 +222,26 @@ public class ChronicleSetBuilder<E>
|
||||
*/
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> objectSerializer(ObjectSerializer objectSerializer) {
|
||||
chronicleMapBuilder.objectSerializer(objectSerializer);
|
||||
chronicleMapBuilderOnHeap.objectSerializer(objectSerializer);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> keyMarshaller(@NotNull BytesMarshaller<E> keyMarshaller) {
|
||||
chronicleMapBuilder.keyMarshaller(keyMarshaller);
|
||||
chronicleMapBuilderOnHeap.keyMarshaller(keyMarshaller);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> keyMarshallers(@NotNull BytesWriter<E> keyWriter,
|
||||
@NotNull BytesReader<E> keyReader) {
|
||||
chronicleMapBuilder.keyMarshallers(keyWriter, keyReader);
|
||||
chronicleMapBuilderOnHeap.keyMarshallers(keyWriter, keyReader);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> keySizeMarshaller(@NotNull SizeMarshaller keySizeMarshaller) {
|
||||
chronicleMapBuilder.keySizeMarshaller(keySizeMarshaller);
|
||||
chronicleMapBuilderOnHeap.keySizeMarshaller(keySizeMarshaller);
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -258,54 +258,54 @@ public class ChronicleSetBuilder<E>
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> keyDeserializationFactory(
|
||||
@NotNull ObjectFactory<E> keyDeserializationFactory) {
|
||||
chronicleMapBuilder.keyDeserializationFactory(keyDeserializationFactory);
|
||||
chronicleMapBuilderOnHeap.keyDeserializationFactory(keyDeserializationFactory);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> immutableKeys() {
|
||||
chronicleMapBuilder.immutableKeys();
|
||||
chronicleMapBuilderOnHeap.immutableKeys();
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> replication(SingleChronicleHashReplication replication) {
|
||||
chronicleMapBuilder.replication(replication);
|
||||
chronicleMapBuilderOnHeap.replication(replication);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> replication(byte identifier, TcpTransportAndNetworkConfig tcpTransportAndNetwork) {
|
||||
chronicleMapBuilder.replication(identifier, tcpTransportAndNetwork);
|
||||
chronicleMapBuilderOnHeap.replication(identifier, tcpTransportAndNetwork);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSetBuilder<E> replication(byte identifier) {
|
||||
chronicleMapBuilder.replication(identifier);
|
||||
chronicleMapBuilderOnHeap.replication(identifier);
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public StatelessClientConfig<ChronicleSet<E>> statelessClient(
|
||||
InetSocketAddress remoteAddress) {
|
||||
return new StatelessSetConfig<>(chronicleMapBuilder.statelessClient(remoteAddress));
|
||||
return new StatelessSetConfig<>(chronicleMapBuilderOnHeap.statelessClient(remoteAddress));
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleHashInstanceConfig<ChronicleSet<E>> instance() {
|
||||
return new InstanceConfig<>(chronicleMapBuilder.instance());
|
||||
return new InstanceConfig<>(chronicleMapBuilderOnHeap.instance());
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSet<E> create() throws IOException {
|
||||
final ChronicleMap<E, DummyValue> map = chronicleMapBuilder.create();
|
||||
final ChronicleMap<E, DummyValue> map = chronicleMapBuilderOnHeap.create();
|
||||
return new SetFromMap<E>(map);
|
||||
}
|
||||
|
||||
@Override
|
||||
public ChronicleSet<E> createPersistedTo(File file) throws IOException {
|
||||
ChronicleMap<E, DummyValue> map = chronicleMapBuilder.createPersistedTo(file);
|
||||
ChronicleMap<E, DummyValue> map = chronicleMapBuilderOnHeap.createPersistedTo(file);
|
||||
return new SetFromMap<E>(map);
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user