From a74596e32e0584aeda4e620e7842c9fce5590e25 Mon Sep 17 00:00:00 2001 From: Peter Lawrey Date: Sat, 15 Nov 2014 16:54:44 +0000 Subject: [PATCH] Javadoc fixes --- .../openhft/chronicle/hash/ChronicleHashBuilder.java | 10 ++++++---- .../java/net/openhft/chronicle/map/ChronicleMap.java | 2 +- src/main/java/net/openhft/chronicle/map/Mutator.java | 2 +- .../net/openhft/chronicle/map/VanillaChronicleMap.java | 2 +- .../net/openhft/chronicle/set/ChronicleSetBuilder.java | 2 +- 5 files changed, 10 insertions(+), 8 deletions(-) mode change 100644 => 100755 src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java mode change 100644 => 100755 src/main/java/net/openhft/chronicle/map/ChronicleMap.java mode change 100644 => 100755 src/main/java/net/openhft/chronicle/map/Mutator.java mode change 100644 => 100755 src/main/java/net/openhft/chronicle/set/ChronicleSetBuilder.java diff --git a/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java b/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java old mode 100644 new mode 100755 index be25be9b4..e07a2e19b --- a/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java +++ b/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java @@ -45,7 +45,8 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.TimeUnit; /** - * This interface defines the meaning of configurations, common to {@link net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder} and + * This interface defines the meaning of configurations, common to + * {@link net.openhft.chronicle.map.OnHeapUpdatableChronicleMapBuilder} and * {@link ChronicleSetBuilder}, i. e. Chronicle hash container configurations. * *

{@code ChronicleHashBuilder} is mutable. Configuration methods mutate the builder and return @@ -129,8 +130,9 @@ public interface ChronicleHashBuilderThere are three major patterns of this configuration usage:

  1. Key (and value, in - * {@code ChronicleMap} case) sizes are constant. Configure them via {@link - * #constantKeySizeBySample(Object)} and {@link net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder#constantValueSizeBySample(Object)} + * {@code ChronicleMap} case) sizes are constant. Configure them via + * {@link #constantKeySizeBySample(Object)} and + * {@link net.openhft.chronicle.map.OnHeapUpdatableChronicleMapBuilder#constantValueSizeBySample(Object)} * methods, and you will experience no memory waste at all.
  2. 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 @@ -183,7 +185,7 @@ public interface ChronicleHashBuilder
  3. 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 - * net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder#valueSize(int) value}/{@linkplain #entrySize(int) entry} sizes.
    4. + * net.openhft.chronicle.map.OnHeapUpdatableChronicleMapBuilder#valueSize(int) value}/{@linkplain #entrySize(int) entry} sizes. *
  4. 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.
diff --git a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java old mode 100644 new mode 100755 index 9e998312a..49e2894bb --- a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java +++ b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java @@ -166,7 +166,7 @@ public interface ChronicleMap extends ConcurrentMap, ChronicleHash { * defaultValueProvider.} * *

If the {@code ChronicleMap} is off-heap updatable, i. e. created via {@link - * ChronicleMapBuilder} builder (values are {@tlink Byteable}), there is one more option of + * 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. diff --git a/src/main/java/net/openhft/chronicle/map/Mutator.java b/src/main/java/net/openhft/chronicle/map/Mutator.java old mode 100644 new mode 100755 index 69c68455c..412d66178 --- a/src/main/java/net/openhft/chronicle/map/Mutator.java +++ b/src/main/java/net/openhft/chronicle/map/Mutator.java @@ -4,7 +4,7 @@ import java.io.Serializable; /** * Represents a mutator that accepts one mutable argument, which it may alter and produces a result. - *

+ * *

This is not functional as it can alter an argument. * * @param the type of the mutable input diff --git a/src/main/java/net/openhft/chronicle/map/VanillaChronicleMap.java b/src/main/java/net/openhft/chronicle/map/VanillaChronicleMap.java index f19a7e31c..95fb2511f 100755 --- a/src/main/java/net/openhft/chronicle/map/VanillaChronicleMap.java +++ b/src/main/java/net/openhft/chronicle/map/VanillaChronicleMap.java @@ -742,7 +742,7 @@ class VanillaChronicleMap, final NativeBytes sizeOfMultiMapBitSetBytes = new NativeBytes(new VanillaBytesMarshallerFactory(), start, start + sizeOfMultiMapBitSet(), null); - multiMapBytes.load(); +// multiMapBytes.load(); return multiMapFactory.create(multiMapBytes, sizeOfMultiMapBitSetBytes); } diff --git a/src/main/java/net/openhft/chronicle/set/ChronicleSetBuilder.java b/src/main/java/net/openhft/chronicle/set/ChronicleSetBuilder.java old mode 100644 new mode 100755 index afd9b463f..aaa85fdcf --- a/src/main/java/net/openhft/chronicle/set/ChronicleSetBuilder.java +++ b/src/main/java/net/openhft/chronicle/set/ChronicleSetBuilder.java @@ -50,7 +50,7 @@ import java.util.concurrent.TimeUnit; * * @param element type of the sets, created by this builder * @see ChronicleSet - * @see net.openhft.chronicle.map.ChronicleMapOnHeapUpdatableBuilder + * @see net.openhft.chronicle.map.OnHeapUpdatableChronicleMapBuilder */ public class ChronicleSetBuilder implements ChronicleHashBuilder, ChronicleSetBuilder> {