From 8a0dea9f05c8b3ba10d103648faab7601d2075be Mon Sep 17 00:00:00 2001 From: leventov Date: Fri, 18 Dec 2015 16:06:05 +0300 Subject: [PATCH] Javadoc fixes in MapMethods --- .../net/openhft/chronicle/map/MapMethods.java | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/main/java/net/openhft/chronicle/map/MapMethods.java b/src/main/java/net/openhft/chronicle/map/MapMethods.java index b5fbf5132..5c803103c 100644 --- a/src/main/java/net/openhft/chronicle/map/MapMethods.java +++ b/src/main/java/net/openhft/chronicle/map/MapMethods.java @@ -41,7 +41,7 @@ public interface MapMethods { * {@link ChronicleMap#getOrDefault} methods. * * @implNote the default implementation is equivalent to
{@code
-     * MapEntry entry = q.entry();
+     * MapEntry entry = q.entry();
      * if (entry != null)
      *     returnValue.returnValue(entry.value());
      * }
@@ -87,7 +87,7 @@ public interface MapMethods { * * @implNote the default implementation is equivalent to
{@code
      * if (q.readLock().tryLock()) {
-     *     MapEntry entry = q.entry();
+     *     MapEntry entry = q.entry();
      *     if (entry != null) {
      *         returnValue.returnValue(entry.value());
      *         return;
@@ -96,7 +96,7 @@ public interface MapMethods {
      *     q.readLock().unlock();
      * }
      * q.updateLock().lock();
-     * MapEntry entry = q.entry();
+     * MapEntry entry = q.entry();
      * if (entry != null) {
      *     returnValue.returnValue(entry.value());
      *     return;
@@ -118,7 +118,7 @@ public interface MapMethods {
      *
      * @implNote the default implementation is equivalent to 
{@code
      * if (q.readLock().tryLock()) {
-     *     MapEntry entry = q.entry();
+     *     MapEntry entry = q.entry();
      *     if (entry != null) {
      *         returnValue.returnValue(entry.value());
      *         return;
@@ -127,7 +127,7 @@ public interface MapMethods {
      *     q.readLock().unlock();
      * }
      * q.updateLock().lock();
-     * MapEntry entry = q.entry();
+     * MapEntry entry = q.entry();
      * if (entry != null) {
      *     returnValue.returnValue(entry.value());
      *     return;
@@ -135,8 +135,8 @@ public interface MapMethods {
      * // Key is absent
      * q.insert(q.absentEntry(), q.defaultValue(q.absentEntry()));
      * // Meaningful to return the default as newly-inserted, not the default entry itself.
-     * // map.acquireUsing() is most useful for data-value generated values, for which it makes
-     * // big difference -- what bytes to refer. Consider map.acquireUsing(...).incrementValue();
+     * // map.acquireUsing() is most useful for value interfaces, for which it makes big
+     * // difference -- what bytes to refer. Consider map.acquireUsing(...).incrementValue();
      * returnValue.returnValue(q.entry().value());
      * }
*/ @@ -146,8 +146,8 @@ public interface MapMethods { // Key is absent q.insert(q.absentEntry(), q.defaultValue(q.absentEntry())); // meaningful to return the default as newly-inserted, not the default entry itself. - // map.acquireUsing() is most useful for data-value generated values, for which it makes - // big difference -- what bytes to refer. consider map.acquireUsing(...).incrementValue(); + // map.acquireUsing() is most useful for value interfaces, for which it makes big + // difference -- what bytes to refer. consider map.acquireUsing(...).incrementValue(); // The same reasoning is applied in all same occurrences in this class file returnValue.returnValue(q.entry().value()); } @@ -157,7 +157,7 @@ public interface MapMethods { * * @implNote the default implementation is equivalent to
{@code
      * if (q.readLock().tryLock()) {
-     *     MapEntry entry = q.entry();
+     *     MapEntry entry = q.entry();
      *     if (entry != null) {
      *         returnValue.returnValue(entry.value());
      *         return;
@@ -166,7 +166,7 @@ public interface MapMethods {
      *     q.readLock().unlock();
      * }
      * q.updateLock().lock();
-     * MapEntry entry = q.entry();
+     * MapEntry entry = q.entry();
      * if (entry != null) {
      *     returnValue.returnValue(entry.value());
      *     return;