diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml index 1e375f5b951..c9a87104254 100644 --- a/.github/workflows/docs-ci.yml +++ b/.github/workflows/docs-ci.yml @@ -20,14 +20,6 @@ jobs: distribution: 'temurin' java-version: '11' - # TODO(deephaven-core#1513): Remove non-LTS JDK 15 as part of javadocs process - - name: Setup JDK 15 - id: setup-java-15 - uses: actions/setup-java@v3 - with: - distribution: 'zulu' - java-version: '15' - - name: Setup JDK 17 id: setup-java-17 uses: actions/setup-java@v3 @@ -42,7 +34,7 @@ jobs: run: | cat .github/env/${{ runner.os }}/gradle.properties >> gradle.properties echo >> gradle.properties - echo "org.gradle.java.installations.paths=${{ steps.setup-java-11.outputs.path }},${{ steps.setup-java-15.outputs.path }},${{ steps.setup-java-17.outputs.path }}" >> gradle.properties + echo "org.gradle.java.installations.paths=${{ steps.setup-java-11.outputs.path }},${{ steps.setup-java-17.outputs.path }}" >> gradle.properties cat gradle.properties - name: All Javadoc @@ -84,14 +76,6 @@ jobs: distribution: 'temurin' java-version: '11' - # TODO(deephaven-core#1513): Remove non-LTS JDK 15 as part of javadocs process - - name: Setup JDK 15 - id: setup-java-15 - uses: actions/setup-java@v3 - with: - distribution: 'zulu' - java-version: '15' - - name: Setup JDK 17 id: setup-java-17 uses: actions/setup-java@v3 @@ -106,7 +90,7 @@ jobs: run: | cat .github/env/${{ runner.os }}/gradle.properties >> gradle.properties echo >> gradle.properties - echo "org.gradle.java.installations.paths=${{ steps.setup-java-11.outputs.path }},${{ steps.setup-java-15.outputs.path }},${{ steps.setup-java-17.outputs.path }}" >> gradle.properties + echo "org.gradle.java.installations.paths=${{ steps.setup-java-11.outputs.path }},${{ steps.setup-java-17.outputs.path }}" >> gradle.properties cat gradle.properties - name: Generate Python Docs diff --git a/Base/src/main/java/io/deephaven/base/ArrayUtil.java b/Base/src/main/java/io/deephaven/base/ArrayUtil.java index b8300338bba..c65cf19a062 100644 --- a/Base/src/main/java/io/deephaven/base/ArrayUtil.java +++ b/Base/src/main/java/io/deephaven/base/ArrayUtil.java @@ -13,7 +13,7 @@ public class ArrayUtil { /** * The maximum array size is determined by the JVM and in practice is less than Integer.MAX_VALUE. (See note at - * {@link jdk.internal.util.ArraysSupport#SOFT_MAX_ARRAY_LENGTH}.) + * {@code jdk.internal.util.ArraysSupport#SOFT_MAX_ARRAY_LENGTH}.) */ // We would like to use jdk.internal.util.ArraysSupport.MAX_ARRAY_LENGTH, but it is not exported public static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; diff --git a/Base/src/main/java/io/deephaven/base/CompareUtils.java b/Base/src/main/java/io/deephaven/base/CompareUtils.java index 2def1fc8365..a3a13e23788 100644 --- a/Base/src/main/java/io/deephaven/base/CompareUtils.java +++ b/Base/src/main/java/io/deephaven/base/CompareUtils.java @@ -120,7 +120,7 @@ public static boolean doubleEquals2(double x, double y, double tolerance) { } /** - * Since logical comparison of double values considerig error is effectively a three-value logic, you can't really + * Since logical comparison of double values considering error is effectively a three-value logic, you can't really * do !equals when you mean notEquals. * * @param x @@ -159,7 +159,7 @@ public static boolean doubleNotEquals2(double x, double y, double tolerance) { } /** - * You can't do double1 > double2 because floating point numbers are not exact values. Just make sure that x-y is + * You can't do double1 > double2 because floating point numbers are not exact values. Just make sure that x-y is * greater than some allowable error factor for equality * * @param x @@ -191,8 +191,8 @@ public static boolean doubleGreaterEqual(double x, double y, double tolerance) { } /** - * You can't do double1 < double2 because floating point numbers are not exact values. Just make sure that y - x is - * greater than some allowable error factor for equality + * You can't do double1 < double2 because floating point numbers are not exact values. Just make sure that y - x + * is greater than some allowable error factor for equality * * @param x * @param y diff --git a/Base/src/main/java/io/deephaven/base/LowGarbageArrayIntegerMap.java b/Base/src/main/java/io/deephaven/base/LowGarbageArrayIntegerMap.java index f01398577b7..ad29fd102e9 100644 --- a/Base/src/main/java/io/deephaven/base/LowGarbageArrayIntegerMap.java +++ b/Base/src/main/java/io/deephaven/base/LowGarbageArrayIntegerMap.java @@ -19,7 +19,7 @@ * when expanding). This set only has one {@link Iterator}, which is reused. This set is not thread safe. *

* Note: This class extends {@link HashMap} rather than {@link Map} (or {@link AbstractMap}) only because one of the - * fields where we want to use it ({@link sun.nio.ch.EPollSelectorImpl#fdToKey}) is (improperly) declared as a HashMap + * fields where we want to use it ({@code sun.nio.ch.EPollSelectorImpl#fdToKey}) is (improperly) declared as a HashMap * rather than a Map. */ public class LowGarbageArrayIntegerMap extends HashMap { diff --git a/Base/src/main/java/io/deephaven/base/LowGarbageArraySet.java b/Base/src/main/java/io/deephaven/base/LowGarbageArraySet.java index 6c3ae204f61..a181145d4e7 100644 --- a/Base/src/main/java/io/deephaven/base/LowGarbageArraySet.java +++ b/Base/src/main/java/io/deephaven/base/LowGarbageArraySet.java @@ -16,7 +16,7 @@ * expanding). This set only has one {@link Iterator}, which is reused. This set is not thread safe. *

* Note: This class extends {@link HashSet} rather than {@link Set} (or {@link AbstractSet}) only because one of the - * fields where we want to use it ({@link sun.nio.ch.SelectorImpl#keys}) is (improperly) declared as a HashSet rather + * fields where we want to use it ({@code sun.nio.ch.SelectorImpl#keys}) is (improperly) declared as a HashSet rather * than a Set. */ public class LowGarbageArraySet extends HashSet { diff --git a/Base/src/main/java/io/deephaven/base/MathUtil.java b/Base/src/main/java/io/deephaven/base/MathUtil.java index 287ab50821a..f7ebc05b6b0 100644 --- a/Base/src/main/java/io/deephaven/base/MathUtil.java +++ b/Base/src/main/java/io/deephaven/base/MathUtil.java @@ -75,7 +75,7 @@ public static int gcd(int a, int b) { }; /** - * Compute 10^n as a int for 0 <= n <= 9. + * Compute 10^n as a int for 0 <= n <= 9. * * @param n the exponent * @return 10^n @@ -95,9 +95,9 @@ public static int pow10(int n) { }; /** - * Compute the number of base 10 digits in n's representation, for n >= 0. + * Compute the number of base 10 digits in n's representation, for n >= 0. * - * @param n an integer >= 0 + * @param n an integer >= 0 * @return how many digits in n's base 10 representation. */ public static int base10digits(int n) { diff --git a/Base/src/main/java/io/deephaven/base/cache/OpenAddressedCanonicalizationCache.java b/Base/src/main/java/io/deephaven/base/cache/OpenAddressedCanonicalizationCache.java index b04dbaa1401..9ac75fc09a8 100644 --- a/Base/src/main/java/io/deephaven/base/cache/OpenAddressedCanonicalizationCache.java +++ b/Base/src/main/java/io/deephaven/base/cache/OpenAddressedCanonicalizationCache.java @@ -48,7 +48,7 @@ public interface Adapter { int hashCode(@NotNull final INPUT_TYPE inputItem); /** - * Note: The following must be true: hashCode(inputItem) == outputItem.hashCode() && equals(inputItem, + * Note: The following must be true: hashCode(inputItem) == outputItem.hashCode() && equals(inputItem, * outputItem) * * @param inputItem The input item diff --git a/Base/src/main/java/io/deephaven/base/stats/Group.java b/Base/src/main/java/io/deephaven/base/stats/Group.java index 3568e4a164b..dda1cb5a01c 100644 --- a/Base/src/main/java/io/deephaven/base/stats/Group.java +++ b/Base/src/main/java/io/deephaven/base/stats/Group.java @@ -95,7 +95,7 @@ public Item[] getItems() { } /** - * Update the histories of all items in this group, logging all updated intervals >= logInterval. + * Update the histories of all items in this group, logging all updated intervals >= logInterval. */ public void update(ItemUpdateListener listener, long logInterval, long now, long appNow) { Item[] arr = itemsArray; diff --git a/Base/src/main/java/io/deephaven/base/stats/Item.java b/Base/src/main/java/io/deephaven/base/stats/Item.java index 6849a494014..38831a7c692 100644 --- a/Base/src/main/java/io/deephaven/base/stats/Item.java +++ b/Base/src/main/java/io/deephaven/base/stats/Item.java @@ -71,7 +71,7 @@ public String getCompactName() { } /** - * Update the history intervals for this item's value, logging updated intervals >= logInterval + * Update the history intervals for this item's value, logging updated intervals >= logInterval */ public void update(ItemUpdateListener listener, long logInterval, long now, long appNow) { value.update(this, listener, logInterval, now, appNow); diff --git a/Base/src/main/java/io/deephaven/base/stats/Stats.java b/Base/src/main/java/io/deephaven/base/stats/Stats.java index d9d671b7d8e..fe5a5a7bced 100644 --- a/Base/src/main/java/io/deephaven/base/stats/Stats.java +++ b/Base/src/main/java/io/deephaven/base/stats/Stats.java @@ -161,7 +161,7 @@ public synchronized static Group getGroup(String name) { } /** - * Update the histories of all items in all groups, logging all updated intervals >= logInterval. + * Update the histories of all items in all groups, logging all updated intervals >= logInterval. */ public synchronized static void update(ItemUpdateListener listener, long now, long appNow, long logInterval) { for (Group g : groups) { diff --git a/Base/src/main/java/io/deephaven/base/string/EncodingInfo.java b/Base/src/main/java/io/deephaven/base/string/EncodingInfo.java index 573053d9d27..da81a36b50a 100644 --- a/Base/src/main/java/io/deephaven/base/string/EncodingInfo.java +++ b/Base/src/main/java/io/deephaven/base/string/EncodingInfo.java @@ -56,7 +56,8 @@ public String getEncodingName() { } /** - * Can this encoding info's charset be encoded or decoded by simple linear assignment of char->byte or byte->char. + * Can this encoding info's charset be encoded or decoded by simple linear assignment of char->byte or + * byte->char. * * @return Whether this encoding info's charset is simple */ diff --git a/Base/src/main/java/io/deephaven/base/string/cache/MappedCompressedString.java b/Base/src/main/java/io/deephaven/base/string/cache/MappedCompressedString.java index 1c9e085f909..9484fd80041 100644 --- a/Base/src/main/java/io/deephaven/base/string/cache/MappedCompressedString.java +++ b/Base/src/main/java/io/deephaven/base/string/cache/MappedCompressedString.java @@ -12,8 +12,8 @@ /** * This is a ridiculously simple, light-as-I-can-make-it, but decidedly single-purpose data structure. Specifically, * it's a CompressedString with an embedded (to avoid reference or Object instance overhead) open-addressed - * SimpleReference-identity -> int hash map with load factor 1 (100%) and no public operations other than - * "putIfAbsent". + * SimpleReference<Object>-identity -> int hash map with load factor 1 (100%) and no public operations other + * than "putIfAbsent". * * The reason for requiring that key objects be SimpleReferences is to allow for O(1) automatic slot reclamation across * many MappedCompressedString instances at the same time. A given source of mappings creates a single SimpleReference @@ -23,8 +23,9 @@ * * Unfortunately, I haven't figured out a way to make this allow concurrent gets. * - * The intended use is in Deephaven import code, for storing SymbolManager -> SymbolId mappings on the CompressedString - * that represents the Symbol itself, typically inside of a (bounded) StringCache of MappedCompressedString instances. + * The intended use is in Deephaven import code, for storing SymbolManager -> SymbolId mappings on the + * CompressedString that represents the Symbol itself, typically inside of a (bounded) StringCache of + * MappedCompressedString instances. * * Note that this uses io.deephaven.base.reference.SimpleReference instead of java.lang.ref.Reference so that unit tests * can avoid being required to use the concrete sub-classes of Reference, which all come with GC-related side-effects. @@ -92,7 +93,7 @@ public final synchronized int capacity() { } /** - * Add the specified pair if no mapping already exists for key. + * Add the specified <key, value> pair if no mapping already exists for key. * * @param key A non-null Reference to an arbitrary object whose reachability determines mapping validity. * @param potentialValue The value to insert if none already exists. Must not equal NULL_MAPPING_VALUE. diff --git a/Base/src/main/java/io/deephaven/base/string/cache/StringCache.java b/Base/src/main/java/io/deephaven/base/string/cache/StringCache.java index f6e4a8bc7fb..3d5d3cf2b45 100644 --- a/Base/src/main/java/io/deephaven/base/string/cache/StringCache.java +++ b/Base/src/main/java/io/deephaven/base/string/cache/StringCache.java @@ -15,7 +15,7 @@ public interface StringCache { /** * Get a hint about this cache's capacity and behavior. * - * @return -1 : This is an unbounded cache. 0 : This "cache" doesn't actually perform any caching. >0 : Actual + * @return -1 : This is an unbounded cache. 0 : This "cache" doesn't actually perform any caching. >0 : Actual * capacity bound. */ int capacity(); diff --git a/Base/src/main/java/io/deephaven/base/string/cache/StringCompatible.java b/Base/src/main/java/io/deephaven/base/string/cache/StringCompatible.java index 17a5517f440..a589857e4fb 100644 --- a/Base/src/main/java/io/deephaven/base/string/cache/StringCompatible.java +++ b/Base/src/main/java/io/deephaven/base/string/cache/StringCompatible.java @@ -59,7 +59,7 @@ public interface StringCompatible extends CharSequence, Comparable /** * Implementations MUST compare StringCompatibles and Strings char-by-char. * - * @return 0, <0, or >0 if that compares equal-to, less-than, or greater-than this. + * @return 0, <0, or >0 if that compares equal-to, less-than, or greater-than this. */ @Override int compareTo(@NotNull final CharSequence that); diff --git a/Base/src/main/java/io/deephaven/base/system/AsyncSystem.java b/Base/src/main/java/io/deephaven/base/system/AsyncSystem.java index 221f4d9ca2a..934bb690b1d 100644 --- a/Base/src/main/java/io/deephaven/base/system/AsyncSystem.java +++ b/Base/src/main/java/io/deephaven/base/system/AsyncSystem.java @@ -82,7 +82,7 @@ public static void exitUncaught(Thread thread, Throwable throwable, int status, } /** - * Equivalent to {@code exitCaught(thread, throwable, status, out, null). + * Equivalent to {@code exitCaught(thread, throwable, status, out, null)}. */ public static void exitCaught(Thread thread, Throwable throwable, int status, PrintStream out) { exitCaught(thread, throwable, status, out, null); diff --git a/Base/src/main/java/io/deephaven/base/verify/Assert.java b/Base/src/main/java/io/deephaven/base/verify/Assert.java index c004872dcaf..f9a78191fcd 100644 --- a/Base/src/main/java/io/deephaven/base/verify/Assert.java +++ b/Base/src/main/java/io/deephaven/base/verify/Assert.java @@ -51,7 +51,7 @@ *

* Naming Rationale: *

    - *
  • eq, neq, lt, leq, gt, get correspond to ==, !=, <, <=, >, >=, e.g., + *
  • eq, neq, lt, leq, gt, get correspond to ==, !=, <, <=, >, >=, e.g., *
      *
    • For Object a and b, Assert.eq(a, "a", b, "b") corresponds to assert (a == b) *
    • For Object o, Assert.neqNull(o, "o") corresponds to assert (o != null) @@ -59,8 +59,9 @@ *
    *
  • equals corresponds to Object.equals (preceded by necessary null checks), e.g., *
      - *
    • For Object a and b, Assert.equals(a, "a", b, "b") corresponds to assert (a!= null && b != null && a.equals(b)) - *
    • for String s, Assert.nonempty(s, "s") corresponds to assert (s != null && s.length() != 0) + *
    • For Object a and b, Assert.equals(a, "a", b, "b") corresponds to assert (a!= null && b != null && + * a.equals(b)) + *
    • for String s, Assert.nonempty(s, "s") corresponds to assert (s != null && s.length() != 0) *
    *
*/ @@ -320,7 +321,7 @@ public static AssertionFailure valueNeverOccurs(double d, String name) { // holdsLock, notHoldsLock // ---------------------------------------------------------------- - /** assert (o != null && (current thread holds o's lock)) */ + /** assert (o != null && (current thread holds o's lock)) */ public static void holdsLock(Object o, String name) { neqNull(o, "o"); if (!Thread.holdsLock(o)) { @@ -329,7 +330,7 @@ public static void holdsLock(Object o, String name) { } // ---------------------------------------------------------------- - /** assert (o != null && !(current thread holds o's lock)) */ + /** assert (o != null && !(current thread holds o's lock)) */ public static void notHoldsLock(Object o, String name) { neqNull(o, "o"); if (Thread.holdsLock(o)) { @@ -611,7 +612,7 @@ public static void neq(double d0, String name0, double d1) { // lt (primitiveValue < primitiveValue) // ---------------------------------------------------------------- - /** assert (c0 < c1) */ + /** assert (c0 < c1) */ public static void lt(char c0, String name0, char c1, String name1) { if (!(c0 < c1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(c0, name0, c1, name1)); @@ -625,7 +626,7 @@ public static void lt(char c0, String name0, char c1) { } // ---------------------------------------------------------------- - /** assert (b0 < b1) */ + /** assert (b0 < b1) */ public static void lt(byte b0, String name0, byte b1, String name1) { if (!(b0 < b1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(b0, name0, b1, name1)); @@ -639,7 +640,7 @@ public static void lt(byte b0, String name0, byte b1) { } // ---------------------------------------------------------------- - /** assert (s0 < s1) */ + /** assert (s0 < s1) */ public static void lt(short s0, String name0, short s1, String name1) { if (!(s0 < s1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(s0, name0, s1, name1)); @@ -653,7 +654,7 @@ public static void lt(short s0, String name0, short s1) { } // ---------------------------------------------------------------- - /** assert (i0 < i1) */ + /** assert (i0 < i1) */ public static void lt(int i0, String name0, int i1, String name1) { if (!(i0 < i1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(i0, name0, i1, name1)); @@ -667,7 +668,7 @@ public static void lt(int i0, String name0, int i1) { } // ---------------------------------------------------------------- - /** assert (l0 < l1) */ + /** assert (l0 < l1) */ public static void lt(long l0, String name0, long l1, String name1) { if (!(l0 < l1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(l0, name0, l1, name1)); @@ -681,7 +682,7 @@ public static void lt(long l0, String name0, long l1) { } // ---------------------------------------------------------------- - /** assert (f0 < f1) */ + /** assert (f0 < f1) */ public static void lt(float f0, String name0, float f1, String name1) { if (!(f0 < f1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(f0, name0, f1, name1)); @@ -695,7 +696,7 @@ public static void lt(float f0, String name0, float f1) { } // ---------------------------------------------------------------- - /** assert (d0 < d1) */ + /** assert (d0 < d1) */ public static void lt(double d0, String name0, double d1, String name1) { if (!(d0 < d1)) { fail(name0 + " < " + name1, ExceptionMessageUtil.valueAndName(d0, name0, d1, name1)); @@ -712,7 +713,7 @@ public static void lt(double d0, String name0, double d1) { // leq (primitiveValue <= primitiveValue) // ---------------------------------------------------------------- - /** assert (c0 <= c1) */ + /** assert (c0 <= c1) */ public static void leq(char c0, String name0, char c1, String name1) { if (!(c0 <= c1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(c0, name0, c1, name1)); @@ -726,7 +727,7 @@ public static void leq(char c0, String name0, char c1) { } // ---------------------------------------------------------------- - /** assert (b0 <= b1) */ + /** assert (b0 <= b1) */ public static void leq(byte b0, String name0, byte b1, String name1) { if (!(b0 <= b1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(b0, name0, b1, name1)); @@ -740,7 +741,7 @@ public static void leq(byte b0, String name0, byte b1) { } // ---------------------------------------------------------------- - /** assert (s0 <= s1) */ + /** assert (s0 <= s1) */ public static void leq(short s0, String name0, short s1, String name1) { if (!(s0 <= s1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(s0, name0, s1, name1)); @@ -754,7 +755,7 @@ public static void leq(short s0, String name0, short s1) { } // ---------------------------------------------------------------- - /** assert (i0 <= i1) */ + /** assert (i0 <= i1) */ public static void leq(int i0, String name0, int i1, String name1) { if (!(i0 <= i1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(i0, name0, i1, name1)); @@ -768,7 +769,7 @@ public static void leq(int i0, String name0, int i1) { } // ---------------------------------------------------------------- - /** assert (l0 <= l1) */ + /** assert (l0 <= l1) */ public static void leq(long l0, String name0, long l1, String name1) { if (!(l0 <= l1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(l0, name0, l1, name1)); @@ -782,7 +783,7 @@ public static void leq(long l0, String name0, long l1) { } // ---------------------------------------------------------------- - /** assert (f0 <= f1) */ + /** assert (f0 <= f1) */ public static void leq(float f0, String name0, float f1, String name1) { if (!(f0 <= f1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(f0, name0, f1, name1)); @@ -796,7 +797,7 @@ public static void leq(float f0, String name0, float f1) { } // ---------------------------------------------------------------- - /** assert (d0 <= d1) */ + /** assert (d0 <= d1) */ public static void leq(double d0, String name0, double d1, String name1) { if (!(d0 <= d1)) { fail(name0 + " <= " + name1, ExceptionMessageUtil.valueAndName(d0, name0, d1, name1)); @@ -813,7 +814,7 @@ public static void leq(double d0, String name0, double d1) { // gt (primitiveValue > primitiveValue) // ---------------------------------------------------------------- - /** assert (c0 > c1) */ + /** assert (c0 > c1) */ public static void gt(char c0, String name0, char c1, String name1) { if (!(c0 > c1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(c0, name0, c1, name1)); @@ -827,7 +828,7 @@ public static void gt(char c0, String name0, char c1) { } // ---------------------------------------------------------------- - /** assert (b0 > b1) */ + /** assert (b0 > b1) */ public static void gt(byte b0, String name0, byte b1, String name1) { if (!(b0 > b1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(b0, name0, b1, name1)); @@ -841,7 +842,7 @@ public static void gt(byte b0, String name0, byte b1) { } // ---------------------------------------------------------------- - /** assert (s0 > s1) */ + /** assert (s0 > s1) */ public static void gt(short s0, String name0, short s1, String name1) { if (!(s0 > s1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(s0, name0, s1, name1)); @@ -855,7 +856,7 @@ public static void gt(short s0, String name0, short s1) { } // ---------------------------------------------------------------- - /** assert (i0 > i1) */ + /** assert (i0 > i1) */ public static void gt(int i0, String name0, int i1, String name1) { if (!(i0 > i1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(i0, name0, i1, name1)); @@ -869,7 +870,7 @@ public static void gt(int i0, String name0, int i1) { } // ---------------------------------------------------------------- - /** assert (l0 > l1) */ + /** assert (l0 > l1) */ public static void gt(long l0, String name0, long l1, String name1) { if (!(l0 > l1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(l0, name0, l1, name1)); @@ -883,7 +884,7 @@ public static void gt(long l0, String name0, long l1) { } // ---------------------------------------------------------------- - /** assert (f0 > f1) */ + /** assert (f0 > f1) */ public static void gt(float f0, String name0, float f1, String name1) { if (!(f0 > f1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(f0, name0, f1, name1)); @@ -897,7 +898,7 @@ public static void gt(float f0, String name0, float f1) { } // ---------------------------------------------------------------- - /** assert (d0 > d1) */ + /** assert (d0 > d1) */ public static void gt(double d0, String name0, double d1, String name1) { if (!(d0 > d1)) { fail(name0 + " > " + name1, ExceptionMessageUtil.valueAndName(d0, name0, d1, name1)); @@ -914,7 +915,7 @@ public static void gt(double d0, String name0, double d1) { // geq (primitiveValue >= primitiveValue) // ---------------------------------------------------------------- - /** assert (c0 >= c1) */ + /** assert (c0 >= c1) */ public static void geq(char c0, String name0, char c1, String name1) { if (!(c0 >= c1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(c0, name0, c1, name1)); @@ -928,7 +929,7 @@ public static void geq(char c0, String name0, char c1) { } // ---------------------------------------------------------------- - /** assert (b0 >= b1) */ + /** assert (b0 >= b1) */ public static void geq(byte b0, String name0, byte b1, String name1) { if (!(b0 >= b1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(b0, name0, b1, name1)); @@ -942,7 +943,7 @@ public static void geq(byte b0, String name0, byte b1) { } // ---------------------------------------------------------------- - /** assert (s0 >= s1) */ + /** assert (s0 >= s1) */ public static void geq(short s0, String name0, short s1, String name1) { if (!(s0 >= s1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(s0, name0, s1, name1)); @@ -956,7 +957,7 @@ public static void geq(short s0, String name0, short s1) { } // ---------------------------------------------------------------- - /** assert (i0 >= i1) */ + /** assert (i0 >= i1) */ public static void geq(int i0, String name0, int i1, String name1) { if (!(i0 >= i1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(i0, name0, i1, name1)); @@ -970,7 +971,7 @@ public static void geq(int i0, String name0, int i1) { } // ---------------------------------------------------------------- - /** assert (l0 >= l1) */ + /** assert (l0 >= l1) */ public static void geq(long l0, String name0, long l1, String name1) { if (!(l0 >= l1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(l0, name0, l1, name1)); @@ -984,7 +985,7 @@ public static void geq(long l0, String name0, long l1) { } // ---------------------------------------------------------------- - /** assert (f0 >= f1) */ + /** assert (f0 >= f1) */ public static void geq(float f0, String name0, float f1, String name1) { if (!(f0 >= f1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(f0, name0, f1, name1)); @@ -998,7 +999,7 @@ public static void geq(float f0, String name0, float f1) { } // ---------------------------------------------------------------- - /** assert (d0 >= d1) */ + /** assert (d0 >= d1) */ public static void geq(double d0, String name0, double d1, String name1) { if (!(d0 >= d1)) { fail(name0 + " >= " + name1, ExceptionMessageUtil.valueAndName(d0, name0, d1, name1)); @@ -1168,7 +1169,7 @@ public static void neqZero(double d, String name) { // ltZero (primitiveValue < 0) // ---------------------------------------------------------------- - /** assert (b < 0) */ + /** assert (b < 0) */ public static void ltZero(byte b, String name) { if (!(b < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(b, name)); @@ -1176,7 +1177,7 @@ public static void ltZero(byte b, String name) { } // ---------------------------------------------------------------- - /** assert (s < 0) */ + /** assert (s < 0) */ public static void ltZero(short s, String name) { if (!(s < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(s, name)); @@ -1184,7 +1185,7 @@ public static void ltZero(short s, String name) { } // ---------------------------------------------------------------- - /** assert (i < 0) */ + /** assert (i < 0) */ public static void ltZero(int i, String name) { if (!(i < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(i, name)); @@ -1192,7 +1193,7 @@ public static void ltZero(int i, String name) { } // ---------------------------------------------------------------- - /** assert (l < 0) */ + /** assert (l < 0) */ public static void ltZero(long l, String name) { if (!(l < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(l, name)); @@ -1200,7 +1201,7 @@ public static void ltZero(long l, String name) { } // ---------------------------------------------------------------- - /** assert (f < 0) */ + /** assert (f < 0) */ public static void ltZero(float f, String name) { if (!(f < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(f, name)); @@ -1208,7 +1209,7 @@ public static void ltZero(float f, String name) { } // ---------------------------------------------------------------- - /** assert (d < 0) */ + /** assert (d < 0) */ public static void ltZero(double d, String name) { if (!(d < 0)) { fail(name + " < 0", ExceptionMessageUtil.valueAndName(d, name)); @@ -1219,7 +1220,7 @@ public static void ltZero(double d, String name) { // leqZero (primitiveValue <= 0) // ---------------------------------------------------------------- - /** assert (b <= 0) */ + /** assert (b <= 0) */ public static void leqZero(byte b, String name) { if (!(b <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(b, name)); @@ -1227,7 +1228,7 @@ public static void leqZero(byte b, String name) { } // ---------------------------------------------------------------- - /** assert (s <= 0) */ + /** assert (s <= 0) */ public static void leqZero(short s, String name) { if (!(s <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(s, name)); @@ -1235,7 +1236,7 @@ public static void leqZero(short s, String name) { } // ---------------------------------------------------------------- - /** assert (i <= 0) */ + /** assert (i <= 0) */ public static void leqZero(int i, String name) { if (!(i <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(i, name)); @@ -1243,7 +1244,7 @@ public static void leqZero(int i, String name) { } // ---------------------------------------------------------------- - /** assert (l <= 0) */ + /** assert (l <= 0) */ public static void leqZero(long l, String name) { if (!(l <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(l, name)); @@ -1251,7 +1252,7 @@ public static void leqZero(long l, String name) { } // ---------------------------------------------------------------- - /** assert (f <= 0) */ + /** assert (f <= 0) */ public static void leqZero(float f, String name) { if (!(f <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(f, name)); @@ -1259,7 +1260,7 @@ public static void leqZero(float f, String name) { } // ---------------------------------------------------------------- - /** assert (d <= 0) */ + /** assert (d <= 0) */ public static void leqZero(double d, String name) { if (!(d <= 0)) { fail(name + " <= 0", ExceptionMessageUtil.valueAndName(d, name)); @@ -1270,7 +1271,7 @@ public static void leqZero(double d, String name) { // gtZero (primitiveValue > 0) // ---------------------------------------------------------------- - /** assert (b > 0) */ + /** assert (b > 0) */ public static void gtZero(byte b, String name) { if (!(b > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(b, name)); @@ -1278,7 +1279,7 @@ public static void gtZero(byte b, String name) { } // ---------------------------------------------------------------- - /** assert (s > 0) */ + /** assert (s > 0) */ public static void gtZero(short s, String name) { if (!(s > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(s, name)); @@ -1286,7 +1287,7 @@ public static void gtZero(short s, String name) { } // ---------------------------------------------------------------- - /** assert (i > 0) */ + /** assert (i > 0) */ public static void gtZero(int i, String name) { if (!(i > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(i, name)); @@ -1294,7 +1295,7 @@ public static void gtZero(int i, String name) { } // ---------------------------------------------------------------- - /** assert (l > 0) */ + /** assert (l > 0) */ public static void gtZero(long l, String name) { if (!(l > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(l, name)); @@ -1302,7 +1303,7 @@ public static void gtZero(long l, String name) { } // ---------------------------------------------------------------- - /** assert (f > 0) */ + /** assert (f > 0) */ public static void gtZero(float f, String name) { if (!(f > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(f, name)); @@ -1310,7 +1311,7 @@ public static void gtZero(float f, String name) { } // ---------------------------------------------------------------- - /** assert (d > 0) */ + /** assert (d > 0) */ public static void gtZero(double d, String name) { if (!(d > 0)) { fail(name + " > 0", ExceptionMessageUtil.valueAndName(d, name)); @@ -1321,7 +1322,7 @@ public static void gtZero(double d, String name) { // geqZero (primitiveValue >= 0) // ---------------------------------------------------------------- - /** assert (b >= 0) */ + /** assert (b >= 0) */ public static void geqZero(byte b, String name) { if (!(b >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(b, name)); @@ -1329,7 +1330,7 @@ public static void geqZero(byte b, String name) { } // ---------------------------------------------------------------- - /** assert (s >= 0) */ + /** assert (s >= 0) */ public static void geqZero(short s, String name) { if (!(s >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(s, name)); @@ -1337,7 +1338,7 @@ public static void geqZero(short s, String name) { } // ---------------------------------------------------------------- - /** assert (i >= 0) */ + /** assert (i >= 0) */ public static void geqZero(int i, String name) { if (!(i >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(i, name)); @@ -1345,7 +1346,7 @@ public static void geqZero(int i, String name) { } // ---------------------------------------------------------------- - /** assert (l >= 0) */ + /** assert (l >= 0) */ public static void geqZero(long l, String name) { if (!(l >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(l, name)); @@ -1353,7 +1354,7 @@ public static void geqZero(long l, String name) { } // ---------------------------------------------------------------- - /** assert (f >= 0) */ + /** assert (f >= 0) */ public static void geqZero(float f, String name) { if (!(f >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(f, name)); @@ -1361,7 +1362,7 @@ public static void geqZero(float f, String name) { } // ---------------------------------------------------------------- - /** assert (d >= 0) */ + /** assert (d >= 0) */ public static void geqZero(double d, String name) { if (!(d >= 0)) { fail(name + " >= 0", ExceptionMessageUtil.valueAndName(d, name)); @@ -1445,7 +1446,7 @@ public static void neqNaN(double d, String name) { // equals (Object.equals(Object)) // ---------------------------------------------------------------- - /** assert (o0 != null && o1 != null && o0.equals(o1)) */ + /** assert (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1, String name1) { neqNull(o0, name0); neqNull(o1, name1); @@ -1455,7 +1456,7 @@ public static void equals(Object o0, String name0, Object o1, String name1) { } // ---------------------------------------------------------------- - /** assert (o0 != null && o1 != null && o0.equals(o1)) */ + /** assert (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1) { neqNull(o0, name0); neqNull(o1, "o1"); @@ -1466,7 +1467,7 @@ public static void equals(Object o0, String name0, Object o1) { } // ---------------------------------------------------------------- - /** assert ((o0 == null && o1 == null) || (o0 != null && o0.equals(o1))) */ + /** assert ((o0 == null && o1 == null) || (o0 != null && o0.equals(o1))) */ public static void nullSafeEquals(Object o0, String name0, Object o1, String name1) { if ((null == o0 && null != o1) || (null != o1 && !o0.equals(o1))) { fail(name0 + ".equals(" + name1 + ")", ExceptionMessageUtil.valueAndName(o0, name0, o1, name1)); @@ -1475,7 +1476,7 @@ public static void nullSafeEquals(Object o0, String name0, Object o1, String nam // ---------------------------------------------------------------- - /** assert (o0 != null && o1 != null && !o0.equals(o1)) */ + /** assert (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1, String name1) { neqNull(o0, name0); neqNull(o1, name1); @@ -1485,7 +1486,7 @@ public static void notEquals(Object o0, String name0, Object o1, String name1) { } // ---------------------------------------------------------------- - /** assert (o0 != null && o1 != null && !o0.equals(o1)) */ + /** assert (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1) { neqNull(o0, name0); neqNull(o1, "o1"); @@ -1499,7 +1500,7 @@ public static void notEquals(Object o0, String name0, Object o1) { // nonempty (String.equals(nonempty)) // ---------------------------------------------------------------- - /** assert (s != null && s.length() > 0) */ + /** assert (s != null && s.length() > 0) */ public static void nonempty(String s, String name) { neqNull(s, name); if (!(s.length() > 0)) { diff --git a/Base/src/main/java/io/deephaven/base/verify/Require.java b/Base/src/main/java/io/deephaven/base/verify/Require.java index 9ff4ff4bb9c..41e79d4c3e1 100644 --- a/Base/src/main/java/io/deephaven/base/verify/Require.java +++ b/Base/src/main/java/io/deephaven/base/verify/Require.java @@ -58,7 +58,7 @@ *

* Naming Rationale: *

    - *
  • eq, neq, lt, leq, gt, get correspond to ==, !=, <, <=, >, >=, e.g., + *
  • eq, neq, lt, leq, gt, get correspond to ==, !=, <, <=, >, >=, e.g., *
      *
    • For Object a and b, Require.eq(a, "a", b, "b") corresponds to require (a == b) *
    • For Object o, Require.neqNull(o, "o") corresponds to require (o != null) @@ -66,8 +66,9 @@ *
    *
  • equals corresponds to Object.equals (preceded by necessary null checks), e.g., *
      - *
    • For Object a and b, Require.equals(a, "a", b, "b") corresponds to require (a!= null && b != null && a.equals(b)) - *
    • for String s, Require.nonempty(s, "s") corresponds to require (s != null && s.length() != 0) + *
    • For Object a and b, Require.equals(a, "a", b, "b") corresponds to require (a!= null && b != null + * && a.equals(b)) + *
    • for String s, Require.nonempty(s, "s") corresponds to require (s != null && s.length() != 0) *
    *
*/ @@ -517,7 +518,7 @@ public static RequirementFailure valueNeverOccurs(double d, String name) { // ---------------------------------------------------------------- /** - * require (o != null && (current thread holds o's lock)) + * require (o != null && (current thread holds o's lock)) */ public static void holdsLock(Object o, String name, int numCallsBelowRequirer) { neqNull(o, "o"); @@ -532,7 +533,7 @@ public static void holdsLock(Object o, String name) { // ---------------------------------------------------------------- /** - * require (o != null && !(current thread holds o's lock)) + * require (o != null && !(current thread holds o's lock)) */ public static void notHoldsLock(Object o, String name, int numCallsBelowRequirer) { neqNull(o, "o"); @@ -1026,7 +1027,7 @@ public static void neq(double d0, String name0, double d1) { // ---------------------------------------------------------------- /** - * require (c0 < c1) + * require (c0 < c1) */ public static char lt(char c0, String name0, char c1, String name1, int numCallsBelowRequirer) { if (!(c0 < c1)) { @@ -1054,7 +1055,7 @@ public static char lt(char c0, String name0, char c1) { // ---------------------------------------------------------------- /** - * require (b0 < b1) + * require (b0 < b1) */ public static byte lt(byte b0, String name0, byte b1, String name1, int numCallsBelowRequirer) { if (!(b0 < b1)) { @@ -1081,7 +1082,7 @@ public static byte lt(byte b0, String name0, byte b1) { // ---------------------------------------------------------------- /** - * require (s0 < s1) + * require (s0 < s1) */ public static short lt(short s0, String name0, short s1, String name1, int numCallsBelowRequirer) { if (!(s0 < s1)) { @@ -1108,7 +1109,7 @@ public static short lt(short s0, String name0, short s1) { // ---------------------------------------------------------------- /** - * require (i0 < i1) + * require (i0 < i1) */ public static int lt(int i0, String name0, int i1, String name1, int numCallsBelowRequirer) { if (!(i0 < i1)) { @@ -1135,7 +1136,7 @@ public static int lt(int i0, String name0, int i1) { // ---------------------------------------------------------------- /** - * require (l0 < l1) + * require (l0 < l1) */ public static long lt(long l0, String name0, long l1, String name1, int numCallsBelowRequirer) { if (!(l0 < l1)) { @@ -1162,7 +1163,7 @@ public static long lt(long l0, String name0, long l1) { // ---------------------------------------------------------------- /** - * require (f0 < f1) + * require (f0 < f1) */ public static float lt(float f0, String name0, float f1, String name1, int numCallsBelowRequirer) { if (!(f0 < f1)) { @@ -1189,7 +1190,7 @@ public static float lt(float f0, String name0, float f1) { // ---------------------------------------------------------------- /** - * require (d0 < d1) + * require (d0 < d1) */ public static double lt(double d0, String name0, double d1, String name1, int numCallsBelowRequirer) { if (!(d0 < d1)) { @@ -1219,7 +1220,7 @@ public static double lt(double d0, String name0, double d1) { // ---------------------------------------------------------------- /** - * require (c0 <= c1) + * require (c0 <= c1) */ public static char leq(char c0, String name0, char c1, String name1, int numCallsBelowRequirer) { if (!(c0 <= c1)) { @@ -1247,7 +1248,7 @@ public static char leq(char c0, String name0, char c1) { // ---------------------------------------------------------------- /** - * require (b0 <= b1) + * require (b0 <= b1) */ public static byte leq(byte b0, String name0, byte b1, String name1, int numCallsBelowRequirer) { if (!(b0 <= b1)) { @@ -1274,7 +1275,7 @@ public static byte leq(byte b0, String name0, byte b1) { // ---------------------------------------------------------------- /** - * require (s0 <= s1) + * require (s0 <= s1) */ public static short leq(short s0, String name0, short s1, String name1, int numCallsBelowRequirer) { if (!(s0 <= s1)) { @@ -1301,7 +1302,7 @@ public static short leq(short s0, String name0, short s1) { // ---------------------------------------------------------------- /** - * require (i0 <= i1) + * require (i0 <= i1) */ public static int leq(int i0, String name0, int i1, String name1, int numCallsBelowRequirer) { if (!(i0 <= i1)) { @@ -1328,7 +1329,7 @@ public static int leq(int i0, String name0, int i1) { // ---------------------------------------------------------------- /** - * require (l0 <= l1) + * require (l0 <= l1) */ public static long leq(long l0, String name0, long l1, String name1, int numCallsBelowRequirer) { if (!(l0 <= l1)) { @@ -1355,7 +1356,7 @@ public static long leq(long l0, String name0, long l1) { // ---------------------------------------------------------------- /** - * require (f0 <= f1) + * require (f0 <= f1) */ public static float leq(float f0, String name0, float f1, String name1, int numCallsBelowRequirer) { if (!(f0 <= f1)) { @@ -1382,7 +1383,7 @@ public static float leq(float f0, String name0, float f1) { // ---------------------------------------------------------------- /** - * require (d0 <= d1) + * require (d0 <= d1) */ public static double leq(double d0, String name0, double d1, String name1, int numCallsBelowRequirer) { if (!(d0 <= d1)) { @@ -1412,7 +1413,7 @@ public static double leq(double d0, String name0, double d1) { // ---------------------------------------------------------------- /** - * require (c0 > c1) + * require (c0 > c1) */ public static char gt(char c0, String name0, char c1, String name1, int numCallsBelowRequirer) { if (!(c0 > c1)) { @@ -1440,7 +1441,7 @@ public static char gt(char c0, String name0, char c1) { // ---------------------------------------------------------------- /** - * require (b0 > b1) + * require (b0 > b1) */ public static byte gt(byte b0, String name0, byte b1, String name1, int numCallsBelowRequirer) { if (!(b0 > b1)) { @@ -1467,7 +1468,7 @@ public static byte gt(byte b0, String name0, byte b1) { // ---------------------------------------------------------------- /** - * require (s0 > s1) + * require (s0 > s1) */ public static short gt(short s0, String name0, short s1, String name1, int numCallsBelowRequirer) { if (!(s0 > s1)) { @@ -1494,7 +1495,7 @@ public static short gt(short s0, String name0, short s1) { // ---------------------------------------------------------------- /** - * require (i0 > i1) + * require (i0 > i1) */ public static int gt(int i0, String name0, int i1, String name1, int numCallsBelowRequirer) { if (!(i0 > i1)) { @@ -1521,7 +1522,7 @@ public static int gt(int i0, String name0, int i1) { // ---------------------------------------------------------------- /** - * require (l0 > l1) + * require (l0 > l1) */ public static long gt(long l0, String name0, long l1, String name1, int numCallsBelowRequirer) { if (!(l0 > l1)) { @@ -1548,7 +1549,7 @@ public static long gt(long l0, String name0, long l1) { // ---------------------------------------------------------------- /** - * require (f0 > f1) + * require (f0 > f1) */ public static float gt(float f0, String name0, float f1, String name1, int numCallsBelowRequirer) { if (!(f0 > f1)) { @@ -1575,7 +1576,7 @@ public static float gt(float f0, String name0, float f1) { // ---------------------------------------------------------------- /** - * require (d0 > d1) + * require (d0 > d1) */ public static double gt(double d0, String name0, double d1, String name1, int numCallsBelowRequirer) { if (!(d0 > d1)) { @@ -1605,7 +1606,7 @@ public static double gt(double d0, String name0, double d1) { // ---------------------------------------------------------------- /** - * require (c0 >= c1) + * require (c0 >= c1) */ public static char geq(char c0, String name0, char c1, String name1, int numCallsBelowRequirer) { if (!(c0 >= c1)) { @@ -1633,7 +1634,7 @@ public static char geq(char c0, String name0, char c1) { // ---------------------------------------------------------------- /** - * require (b0 >= b1) + * require (b0 >= b1) */ public static byte geq(byte b0, String name0, byte b1, String name1, int numCallsBelowRequirer) { if (!(b0 >= b1)) { @@ -1660,7 +1661,7 @@ public static byte geq(byte b0, String name0, byte b1) { // ---------------------------------------------------------------- /** - * require (s0 >= s1) + * require (s0 >= s1) */ public static short geq(short s0, String name0, short s1, String name1, int numCallsBelowRequirer) { if (!(s0 >= s1)) { @@ -1687,7 +1688,7 @@ public static short geq(short s0, String name0, short s1) { // ---------------------------------------------------------------- /** - * require (i0 >= i1) + * require (i0 >= i1) */ public static int geq(int i0, String name0, int i1, String name1, int numCallsBelowRequirer) { if (!(i0 >= i1)) { @@ -1714,7 +1715,7 @@ public static int geq(int i0, String name0, int i1) { // ---------------------------------------------------------------- /** - * require (l0 >= l1) + * require (l0 >= l1) */ public static long geq(long l0, String name0, long l1, String name1, int numCallsBelowRequirer) { if (!(l0 >= l1)) { @@ -1741,7 +1742,7 @@ public static long geq(long l0, String name0, long l1) { // ---------------------------------------------------------------- /** - * require (f0 >= f1) + * require (f0 >= f1) */ public static float geq(float f0, String name0, float f1, String name1, int numCallsBelowRequirer) { if (!(f0 >= f1)) { @@ -1768,7 +1769,7 @@ public static float geq(float f0, String name0, float f1) { // ---------------------------------------------------------------- /** - * require (d0 >= d1) + * require (d0 >= d1) */ public static double geq(double d0, String name0, double d1, String name1, int numCallsBelowRequirer) { if (!(d0 >= d1)) { @@ -2067,7 +2068,7 @@ public static double neqZero(double d, String name) { // ---------------------------------------------------------------- /** - * require (b < 0) + * require (b < 0) */ public static byte ltZero(byte b, String name, int numCallsBelowRequirer) { if (!(b < 0)) { @@ -2082,7 +2083,7 @@ public static byte ltZero(byte b, String name) { // ---------------------------------------------------------------- /** - * require (s < 0) + * require (s < 0) */ public static short ltZero(short s, String name, int numCallsBelowRequirer) { if (!(s < 0)) { @@ -2097,7 +2098,7 @@ public static short ltZero(short s, String name) { // ---------------------------------------------------------------- /** - * require (i < 0) + * require (i < 0) */ public static int ltZero(int i, String name, int numCallsBelowRequirer) { if (!(i < 0)) { @@ -2112,7 +2113,7 @@ public static int ltZero(int i, String name) { // ---------------------------------------------------------------- /** - * require (l < 0) + * require (l < 0) */ public static long ltZero(long l, String name, int numCallsBelowRequirer) { if (!(l < 0)) { @@ -2127,7 +2128,7 @@ public static long ltZero(long l, String name) { // ---------------------------------------------------------------- /** - * require (f < 0) + * require (f < 0) */ public static float ltZero(float f, String name, int numCallsBelowRequirer) { if (!(f < 0)) { @@ -2142,7 +2143,7 @@ public static float ltZero(float f, String name) { // ---------------------------------------------------------------- /** - * require (d < 0) + * require (d < 0) */ public static double ltZero(double d, String name, int numCallsBelowRequirer) { if (!(d < 0)) { @@ -2160,7 +2161,7 @@ public static double ltZero(double d, String name) { // ---------------------------------------------------------------- /** - * require (b <= 0) + * require (b <= 0) */ public static byte leqZero(byte b, String name, int numCallsBelowRequirer) { if (!(b <= 0)) { @@ -2175,7 +2176,7 @@ public static byte leqZero(byte b, String name) { // ---------------------------------------------------------------- /** - * require (s <= 0) + * require (s <= 0) */ public static short leqZero(short s, String name, int numCallsBelowRequirer) { if (!(s <= 0)) { @@ -2190,7 +2191,7 @@ public static short leqZero(short s, String name) { // ---------------------------------------------------------------- /** - * require (i <= 0) + * require (i <= 0) */ public static int leqZero(int i, String name, int numCallsBelowRequirer) { if (!(i <= 0)) { @@ -2205,7 +2206,7 @@ public static int leqZero(int i, String name) { // ---------------------------------------------------------------- /** - * require (l <= 0) + * require (l <= 0) */ public static long leqZero(long l, String name, int numCallsBelowRequirer) { if (!(l <= 0)) { @@ -2220,7 +2221,7 @@ public static long leqZero(long l, String name) { // ---------------------------------------------------------------- /** - * require (f <= 0) + * require (f <= 0) */ public static float leqZero(float f, String name, int numCallsBelowRequirer) { if (!(f <= 0)) { @@ -2235,7 +2236,7 @@ public static float leqZero(float f, String name) { // ---------------------------------------------------------------- /** - * require (d <= 0) + * require (d <= 0) */ public static double leqZero(double d, String name, int numCallsBelowRequirer) { if (!(d <= 0)) { @@ -2253,7 +2254,7 @@ public static double leqZero(double d, String name) { // ---------------------------------------------------------------- /** - * require (b > 0) + * require (b > 0) */ public static byte gtZero(byte b, String name, int numCallsBelowRequirer) { if (!(b > 0)) { @@ -2268,7 +2269,7 @@ public static byte gtZero(byte b, String name) { // ---------------------------------------------------------------- /** - * require (s > 0) + * require (s > 0) */ public static short gtZero(short s, String name, int numCallsBelowRequirer) { if (!(s > 0)) { @@ -2283,7 +2284,7 @@ public static short gtZero(short s, String name) { // ---------------------------------------------------------------- /** - * require (i > 0) + * require (i > 0) */ public static int gtZero(int i, String name, int numCallsBelowRequirer) { if (!(i > 0)) { @@ -2298,7 +2299,7 @@ public static int gtZero(int i, String name) { // ---------------------------------------------------------------- /** - * require (l > 0) + * require (l > 0) */ public static long gtZero(long l, String name, int numCallsBelowRequirer) { if (!(l > 0)) { @@ -2313,7 +2314,7 @@ public static long gtZero(long l, String name) { // ---------------------------------------------------------------- /** - * require (f > 0) + * require (f > 0) */ public static float gtZero(float f, String name, int numCallsBelowRequirer) { if (!(f > 0)) { @@ -2346,7 +2347,7 @@ public static double gtZero(double d, String name) { // ---------------------------------------------------------------- /** - * require (b >= 0) + * require (b >= 0) */ public static byte geqZero(byte b, String name, int numCallsBelowRequirer) { if (!(b >= 0)) { @@ -2361,7 +2362,7 @@ public static byte geqZero(byte b, String name) { // ---------------------------------------------------------------- /** - * require (s >= 0) + * require (s >= 0) */ public static short geqZero(short s, String name, int numCallsBelowRequirer) { if (!(s >= 0)) { @@ -2376,7 +2377,7 @@ public static short geqZero(short s, String name) { // ---------------------------------------------------------------- /** - * require (i >= 0) + * require (i >= 0) */ public static int geqZero(int i, String name, int numCallsBelowRequirer) { if (!(i >= 0)) { @@ -2391,7 +2392,7 @@ public static int geqZero(int i, String name) { // ---------------------------------------------------------------- /** - * require (l >= 0) + * require (l >= 0) */ public static long geqZero(long l, String name, int numCallsBelowRequirer) { if (!(l >= 0)) { @@ -2406,7 +2407,7 @@ public static long geqZero(long l, String name) { // ---------------------------------------------------------------- /** - * require (f >= 0) + * require (f >= 0) */ public static float geqZero(float f, String name, int numCallsBelowRequirer) { if (!(f >= 0)) { @@ -2421,7 +2422,7 @@ public static float geqZero(float f, String name) { // ---------------------------------------------------------------- /** - * require (d >= 0) + * require (d >= 0) */ public static double geqZero(double d, String name, int numCallsBelowRequirer) { if (!(d >= 0)) { @@ -2560,7 +2561,7 @@ public static double neqInf(double o, String name) { // ---------------------------------------------------------------- /** - * require (o0 != null && o1 != null && o0.equals(o1)) + * require (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1, String name1, int numCallsBelowRequirer) { neqNull(o0, name0, numCallsBelowRequirer + 1); @@ -2572,14 +2573,14 @@ public static void equals(Object o0, String name0, Object o1, String name1, int } /** - * require (o0 != null && o1 != null && o0.equals(o1)) + * require (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1, String name1) { equals(o0, name0, o1, name1, 1); } /** - * require (o0 != null && o1 != null && o0.equals(o1)) + * require (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1, int numCallsBelowRequirer) { neqNull(o0, name0, numCallsBelowRequirer + 1); @@ -2591,7 +2592,7 @@ public static void equals(Object o0, String name0, Object o1, int numCallsBelowR } /** - * require (o0 != null && o1 != null && o0.equals(o1)) + * require (o0 != null && o1 != null && o0.equals(o1)) */ public static void equals(Object o0, String name0, Object o1) { equals(o0, name0, o1, 1); @@ -2599,7 +2600,7 @@ public static void equals(Object o0, String name0, Object o1) { // ---------------------------------------------------------------- /** - * require (o0 != null && o1 != null && !o0.equals(o1)) + * require (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1, String name1, int numCallsBelowRequirer) { neqNull(o0, name0, numCallsBelowRequirer + 1); @@ -2611,14 +2612,14 @@ public static void notEquals(Object o0, String name0, Object o1, String name1, i } /** - * require (o0 != null && o1 != null && !o0.equals(o1)) + * require (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1, String name1) { notEquals(o0, name0, o1, name1, 1); } /** - * require (o0 != null && o1 != null && !o0.equals(o1)) + * require (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1, int numCallsBelowRequirer) { neqNull(o0, name0, numCallsBelowRequirer + 1); @@ -2630,7 +2631,7 @@ public static void notEquals(Object o0, String name0, Object o1, int numCallsBel } /** - * require (o0 != null && o1 != null && !o0.equals(o1)) + * require (o0 != null && o1 != null && !o0.equals(o1)) */ public static void notEquals(Object o0, String name0, Object o1) { notEquals(o0, name0, o1, 1); @@ -2641,7 +2642,7 @@ public static void notEquals(Object o0, String name0, Object o1) { // ---------------------------------------------------------------- /** - * require (s != null && s.length() > 0) + * require (s != null && s.length() > 0) */ public static String nonempty(String s, String name, int numCallsBelowRequirer) { neqNull(s, name, numCallsBelowRequirer + 1); @@ -2658,7 +2659,7 @@ public static String nonempty(String s, String name) { // ################################################################ // ---------------------------------------------------------------- - /** require (collection != null && collection.contains(element)) */ + /** require (collection != null && collection.contains(element)) */ public static , T> C contains(C collection, String collectionName, T element, String elementName, int numCallsBelowRequirer) { neqNull(collection, collectionName, numCallsBelowRequirer + 1); @@ -2675,7 +2676,7 @@ public static , T> C contains(C collection, String colle } // ---------------------------------------------------------------- - /** require (collection != null && !collection.contains(element)) */ + /** require (collection != null && !collection.contains(element)) */ public static , T> C notContains(C collection, String collectionName, T element, String elementName, int numCallsBelowRequirer) { neqNull(collection, collectionName, numCallsBelowRequirer + 1); @@ -2692,7 +2693,7 @@ public static , T> C notContains(C collection, String co } // ---------------------------------------------------------------- - /** require (collection != null && !collection.stream().anyMatch(Objects::isNull) */ + /** require (collection != null && !collection.stream().anyMatch(Objects::isNull) */ public static , T> C notContainsNull(C collection, String collectionName, int numCallsBelowRequirer) { neqNull(collection, collectionName, numCallsBelowRequirer + 1); @@ -2707,7 +2708,7 @@ public static , T> C notContainsNull(C collection, Strin } // ---------------------------------------------------------------- - /** require (map != null && map.containsKey(key)) */ + /** require (map != null && map.containsKey(key)) */ public static , K, V> M containsKey(M map, String mapName, K key, String keyName, int numCallsBelowRequirer) { neqNull(map, mapName, numCallsBelowRequirer + 1); @@ -2723,7 +2724,7 @@ public static , K, V> M containsKey(M map, String mapName, K } // ---------------------------------------------------------------- - /** require (map != null && !map.containsKey(element)) */ + /** require (map != null && !map.containsKey(element)) */ public static , K, V> M notContainsKey(M map, String mapName, K key, String keyName, int numCallsBelowRequirer) { neqNull(map, mapName, numCallsBelowRequirer + 1); @@ -2739,7 +2740,7 @@ public static , K, V> M notContainsKey(M map, String mapName } // ---------------------------------------------------------------- - /** require (offset >= 0 && offset < length) */ + /** require (offset >= 0 && offset < length) */ public static int inRange(int offset, String offsetName, int length, String lengthName, int numCallsBelowRequirer) { if (!(offset >= 0)) { fail(offsetName + " >= 0", ExceptionMessageUtil.valueAndName(offset, offsetName), @@ -2752,13 +2753,13 @@ public static int inRange(int offset, String offsetName, int length, String leng return offset; } - /** require (offset >= 0 && offset < length) */ + /** require (offset >= 0 && offset < length) */ public static int inRange(int offset, String offsetName, int length, String lengthName) { return inRange(offset, offsetName, length, lengthName, 1); } // ---------------------------------------------------------------- - /** require (offset >= start && offset < end) */ + /** require (offset >= start && offset < end) */ public static int inRange(int offset, String offsetName, int start, String startName, int end, String endName, int numCallsBelowRequirer) { if (!(offset >= start)) { @@ -2771,13 +2772,13 @@ public static int inRange(int offset, String offsetName, int start, String start return offset; } - /** require (offset >= start && offset < end) */ + /** require (offset >= start && offset < end) */ public static int inRange(int offset, String offsetName, int start, String startName, int end, String endName) { return inRange(offset, offsetName, start, startName, end, endName, 1); } // ---------------------------------------------------------------- - /** require (offset >= 0 && offset < length) */ + /** require (offset >= 0 && offset < length) */ public static long inRange(long offset, String offsetName, long length, String lengthName, int numCallsBelowRequirer) { if (!(offset >= 0L)) { @@ -2791,13 +2792,13 @@ public static long inRange(long offset, String offsetName, long length, String l return offset; } - /** require (offset >= 0 && offset < length) */ + /** require (offset >= 0 && offset < length) */ public static long inRange(long offset, String offsetName, long length, String lengthName) { return inRange(offset, offsetName, length, lengthName, 1); } // ---------------------------------------------------------------- - /** require (offset >= start && offset < end) */ + /** require (offset >= start && offset < end) */ public static long inRange(long offset, String offsetName, long start, String startName, long end, String endName, int numCallsBelowRequirer) { if (!(offset >= start)) { @@ -2810,7 +2811,7 @@ public static long inRange(long offset, String offsetName, long start, String st return offset; } - /** require (offset >= start && offset < end) */ + /** require (offset >= start && offset < end) */ public static long inRange(long offset, String offsetName, long start, String startName, long end, String endName) { return inRange(offset, offsetName, start, startName, end, endName, 1); } diff --git a/Configuration/src/main/java/io/deephaven/configuration/PropertyFile.java b/Configuration/src/main/java/io/deephaven/configuration/PropertyFile.java index 7dad8105165..174ebadbc27 100644 --- a/Configuration/src/main/java/io/deephaven/configuration/PropertyFile.java +++ b/Configuration/src/main/java/io/deephaven/configuration/PropertyFile.java @@ -39,7 +39,7 @@ public PropertyFile() { * * @param filename name of file to load properties from * @param log Logger for error/warning messages, or null if not logging - * @param fatal If the file can't be read and fatal is true -> throw exception + * @param fatal If the file can't be read and fatal is true -> throw exception */ public PropertyFile(String filename, Logger log, boolean fatal) { this.log = log; diff --git a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/Container.java b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/Container.java index 2f7ecf74168..868da8a4b56 100644 --- a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/Container.java +++ b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/Container.java @@ -142,7 +142,7 @@ public static Container twoValues(final short v1, final short v2) { /** * Returns a new Container containing the two provided ranges. The ranges provided should be nonempty, disjoint and - * provided in appearance order, ie, start2 > start1. + * provided in appearance order, ie, start2 > start1. * * @param start1 start of first range, inclusive. * @param end1 end of first range, exclusive. @@ -1149,7 +1149,7 @@ public final Container remove(short x) { * * @param outPositions accept is called in this consumer for each resulting position range. * @param inValues input iterator that provides the key ranges; these must each exist in the container. - * @param maxPos maximum position to add to outPositions; values of position > maxPos are not added. + * @param maxPos maximum position to add to outPositions; values of position > maxPos are not added. * @return true if maxPos was reached, false otherwise. */ public abstract boolean findRanges(RangeConsumer outPositions, RangeIterator inValues, int maxPos); diff --git a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/ContainerUtil.java b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/ContainerUtil.java index fb82f5f0383..5ec912a7dee 100644 --- a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/ContainerUtil.java +++ b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/ContainerUtil.java @@ -137,22 +137,22 @@ public interface TargetComparator { * greater than the provided value, respectively. * * @param value - * @return -1 if target is to the left of value (target < value ); 0 if value == target; +1 if target is to the - * right of value (value < target). + * @return -1 if target is to the left of value (target < value ); 0 if value == target; +1 if target is to + * the right of value (value < target). */ int directionFrom(final int value); } /** - * Search for the largest value in array such that comp.directionFrom(value) > 0, or any value such that + * Search for the largest value in array such that comp.directionFrom(value) > 0, or any value such that * comp.directionFrom(value) == 0, and return its index. If there is no such a value return -1. * * @param array Array with values sorted in increasing order. * @param begin Start position in the array for the search. * @param end One past the last position in the array for the search. * @param comp A comparator. - * @return -1 if comp.directionFrom(array[begin]) < 0, otherwise the biggest position pos in [begin, end - 1] such - * that comp.directionFrom(array[pos]) > 0 or, if there is a one or more positions pos for which + * @return -1 if comp.directionFrom(array[begin]) < 0, otherwise the biggest position pos in [begin, end - 1] + * such that comp.directionFrom(array[pos]) > 0 or, if there is a one or more positions pos for which * comp.directionFrom(array[pos]) == 0, return any of them. */ public static int search(final short[] array, final int begin, final int end, final TargetComparator comp) { @@ -203,12 +203,12 @@ public static int search(final short[] array, final int begin, final int end, fi } /** - * Look for the biggest value of i that satisfies begin <= i < end and comp.directionFrom(i) >= 0. + * Look for the biggest value of i that satisfies begin <= i < end and comp.directionFrom(i) >= 0. * * @param begin The beginning of the range (inclusive) * @param end The end of the range (exclusive) * @param comp a TargetComparator. - * @return the last position i inside the provided range that satisfies comp.directionFrom(i) >= 0, or -1 if none + * @return the last position i inside the provided range that satisfies comp.directionFrom(i) >= 0, or -1 if none * does. */ public static int rangeSearch(final int begin, final int end, final TargetComparator comp) { diff --git a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/SearchRangeIterator.java b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/SearchRangeIterator.java index dd15828b597..c8784fe3733 100644 --- a/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/SearchRangeIterator.java +++ b/Container/src/main/java/io/deephaven/engine/rowset/impl/rsp/container/SearchRangeIterator.java @@ -27,17 +27,17 @@ public interface SearchRangeIterator extends RangeIterator { /** *

- * Advance the current iterator (start) position while the current value maintains comp.directionFrom(v) > 0. If - * next to the last such value there is a value for which comp.directionFrom(v) < 0, or no further values exist, - * then that last value satisfying comp,.directionFrom(v) > 0 is left as the current position and true is returned. - * If there are any elements for which comp.directionFrom(v) == 0, one of such elements, no guarantee which one, is - * left as the current position and true is returned. If at the call entry, the next range starts at a point where - * comp.directionFrom(v) < 0, false is returned and the current position is not moved. + * Advance the current iterator (start) position while the current value maintains comp.directionFrom(v) > 0. If + * next to the last such value there is a value for which comp.directionFrom(v) < 0, or no further values exist, + * then that last value satisfying comp,.directionFrom(v) > 0 is left as the current position and true is + * returned. If there are any elements for which comp.directionFrom(v) == 0, one of such elements, no guarantee + * which one, is left as the current position and true is returned. If at the call entry, the next range starts at a + * point where comp.directionFrom(v) < 0, false is returned and the current position is not moved. *

* *

* Note the iterator may not move if at the time of the call, the iterator's current range start position satisfies - * comp.directionFrom(v) >= 0 and there is no other value in the iterator that does. + * comp.directionFrom(v) >= 0 and there is no other value in the iterator that does. *

* * @@ -49,9 +49,9 @@ public interface SearchRangeIterator extends RangeIterator { * @param comp a comparator used to search forward from the current iterator position * @return false if the target was to the left of the initial position at the time of the call (iterator not * changed); true otherwise. In the true case the current position is guaranteed to satisfy - * comp.directionFrom(v) >= 0 and if also comp.directionFrom(v) > 0, then v is the biggest such value for - * which comp.directionFrom(v) > 0. If there are multiple values for which comp.directionFrom(v) == 0, there - * is no guarantee as of which one will be left as current iterator position. + * comp.directionFrom(v) >= 0 and if also comp.directionFrom(v) > 0, then v is the biggest such value + * for which comp.directionFrom(v) > 0. If there are multiple values for which comp.directionFrom(v) == + * 0, there is no guarantee as of which one will be left as current iterator position. */ boolean search(ContainerUtil.TargetComparator comp); } diff --git a/DHProcess/src/main/java/io/deephaven/process/SystemCpuOshi.java b/DHProcess/src/main/java/io/deephaven/process/SystemCpuOshi.java index c2f9f4d88f3..fb4efa8dd85 100644 --- a/DHProcess/src/main/java/io/deephaven/process/SystemCpuOshi.java +++ b/DHProcess/src/main/java/io/deephaven/process/SystemCpuOshi.java @@ -58,9 +58,9 @@ public abstract class SystemCpuOshi implements PropertySet { /** * Gets the Processor ID. This is a hexidecimal string representing an 8-byte value, normally obtained using the * CPUID opcode with the EAX register set to 1. The first four bytes are the resulting contents of the EAX register, - * which is the Processor signature, represented in human-readable form by {@link #getIdentifier()} . The remaining - * four bytes are the contents of the EDX register, containing feature flags. - * + * which is the Processor signature. The remaining four bytes are the contents of the EDX register, containing + * feature flags. + *

* NOTE: The order of returned bytes is platform and software dependent. Values may be in either Big Endian or * Little Endian order. * diff --git a/FishUtil/src/main/java/io/deephaven/util/signals/SignalSender.java b/FishUtil/src/main/java/io/deephaven/util/signals/SignalSender.java index 710a84c92d4..c039e5a79ee 100644 --- a/FishUtil/src/main/java/io/deephaven/util/signals/SignalSender.java +++ b/FishUtil/src/main/java/io/deephaven/util/signals/SignalSender.java @@ -100,7 +100,7 @@ private boolean sendSignal(final int processId, final SignalUtils.Signal signal) /** * Simple program for functionality testing. * - * @param args [ ] + * @param args [ <pid> <signal> <use native?> ] */ public static void main(final String... args) { final int pid = Integer.parseInt(args[0]); diff --git a/Generators/src/main/java/io/deephaven/libs/GroovyStaticImportGenerator.java b/Generators/src/main/java/io/deephaven/libs/GroovyStaticImportGenerator.java index d19df581748..ecb6da2b5a6 100644 --- a/Generators/src/main/java/io/deephaven/libs/GroovyStaticImportGenerator.java +++ b/Generators/src/main/java/io/deephaven/libs/GroovyStaticImportGenerator.java @@ -305,7 +305,7 @@ private String generateCode() { String returnType = f.returnType.getTypeName(); String s = " /** @see " + f.getClassName() + "#" + f.getMethodName() + "(" + - Arrays.stream(f.parameterTypes).map(t -> t.getTypeName().replaceAll("<.*>", "")) + Arrays.stream(f.parameterTypes).map(t -> getParamTypeString(t)) .collect(Collectors.joining(",")) + ") */\n" + @@ -368,6 +368,24 @@ private String generateCode() { return code; } + /** + * Helper to transform method parameter types to a form that can be used in a javadoc link, including removing + * generics and finding the upper bound of typevars. + */ + @NotNull + private String getParamTypeString(Type t) { + if (t instanceof ParameterizedType) { + return ((ParameterizedType) t).getRawType().getTypeName(); + } else if (t instanceof TypeVariable) { + return getParamTypeString(((TypeVariable) t).getBounds()[0]); + } else if (t instanceof WildcardType) { + return getParamTypeString(((WildcardType) t).getUpperBounds()[0]); + } else if (t instanceof GenericArrayType) { + return getParamTypeString(((GenericArrayType) t).getGenericComponentType()) + "[]"; + } + return t.getTypeName(); + } + public static void main(String[] args) throws ClassNotFoundException, IOException { String devroot = null; diff --git a/IO/src/main/java/io/deephaven/io/streams/BufferedChannelReader.java b/IO/src/main/java/io/deephaven/io/streams/BufferedChannelReader.java index a6af9221304..1a78fef7fa6 100644 --- a/IO/src/main/java/io/deephaven/io/streams/BufferedChannelReader.java +++ b/IO/src/main/java/io/deephaven/io/streams/BufferedChannelReader.java @@ -20,8 +20,8 @@ public class BufferedChannelReader { private int limit; /** - * Guarantees that each buffer from readNext() will have remaining() >= blockSize [that is, until it starts winding - * down on the end of the file] When it needs to refresh, it will read <= readSize from the channel + * Guarantees that each buffer from readNext() will have remaining() >= blockSize [that is, until it starts + * winding down on the end of the file] When it needs to refresh, it will read <= readSize from the channel */ public BufferedChannelReader(final String filename, int blockSize, int readSize) { Require.leq(blockSize, "blockSize", readSize, "readSize"); diff --git a/IO/src/main/java/io/deephaven/io/streams/ByteBufferSink.java b/IO/src/main/java/io/deephaven/io/streams/ByteBufferSink.java index eabe6159c0b..b2f7876566e 100644 --- a/IO/src/main/java/io/deephaven/io/streams/ByteBufferSink.java +++ b/IO/src/main/java/io/deephaven/io/streams/ByteBufferSink.java @@ -10,7 +10,7 @@ public interface ByteBufferSink { /** * Dispose of the contents of the buffer b, probably by writing them to a channel, and return a new buffer in which * writing can continue. The returned buffer must have at least need bytes of space remaining. The return value may - * be the same buffer, as long as it's remaining() value has been increased to be >= need. + * be the same buffer, as long as it's remaining() value has been increased to be >= need. * * @param b the buffer whose contents need to be disposed of. * @return the buffer in which further output should be written. diff --git a/IO/src/main/java/io/deephaven/io/streams/ByteBufferStreams.java b/IO/src/main/java/io/deephaven/io/streams/ByteBufferStreams.java index 0c1f9f08682..48c0446d7bd 100644 --- a/IO/src/main/java/io/deephaven/io/streams/ByteBufferStreams.java +++ b/IO/src/main/java/io/deephaven/io/streams/ByteBufferStreams.java @@ -24,7 +24,7 @@ public interface Sink { /** * Dispose of the contents of the buffer b, probably by writing them to a channel, and return a new buffer in * which writing can continue. The returned buffer must have at least need bytes of space remaining. The return - * value may be the same buffer, as long as it's remaining() value has been increased to be >= need. + * value may be the same buffer, as long as it's remaining() value has been increased to be >= need. * * @param b the buffer whose contents need to be disposed of. * @return the buffer in which further output should be written. diff --git a/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmBase.java b/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmBase.java index 33d0e79b709..b3e10500757 100644 --- a/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmBase.java +++ b/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmBase.java @@ -203,7 +203,8 @@ interface MostRecentDataGetter { * {@code FitDataPopulator} with the appropriate value for usePrev. * * @param lockType The way of acquiring the {@code UpdateGraphProcessor} lock. - * @return A function that runs a {@link } + * @return A function that runs an operation which accepts a {@link QueryDataRetrievalOperation} and a + * {@link Table}. */ @SuppressWarnings("WeakerAccess") protected static ThrowingBiConsumer getDoLockedConsumer( diff --git a/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmOnDemand.java b/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmOnDemand.java index f2c62f09927..15d052dcf15 100644 --- a/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmOnDemand.java +++ b/ModelFarm/src/main/java/io/deephaven/modelfarm/ModelFarmOnDemand.java @@ -20,11 +20,9 @@ * A ModelFarm implementation for evaluating a model upon request, retrieving a snapshot of data for all keys under a * single {@link UpdateGraphProcessor} lock. * - * @param The type of the keys (e.g. {@link io.deephaven.modelfarm.fitterfarm.FitScope}). - * @param The type of the data (e.g. - * {@link io.deephaven.modelfarm.fitterfarm.futures.FuturesFitDataOptionPrices}. - * @param The type of the RowDataManager (e.g. - * {@link io.deephaven.modelfarm.fitterfarm.futures.FuturesFitDataManager}). + * @param The type of keys. + * @param The type of data. + * @param The type of RowDataManager. */ public class ModelFarmOnDemand> extends ModelFarmBase { diff --git a/ModelFarm/src/main/java/io/deephaven/modelfarm/RDMModelFarm.java b/ModelFarm/src/main/java/io/deephaven/modelfarm/RDMModelFarm.java index 3b4da0aa79a..064349e57c5 100644 --- a/ModelFarm/src/main/java/io/deephaven/modelfarm/RDMModelFarm.java +++ b/ModelFarm/src/main/java/io/deephaven/modelfarm/RDMModelFarm.java @@ -23,11 +23,9 @@ * table}. Each row of this table should contain all of the data necessary to populate an instance of {@code DATATYPE}, * which will then be passed to the {@link ModelFarmBase#model model}. * - * @param The type of the keys (e.g. {@link io.deephaven.modelfarm.fitterfarm.FitScope}). - * @param The type of the data (e.g. - * {@link io.deephaven.modelfarm.fitterfarm.futures.FuturesFitDataOptionPrices}. - * @param The type of the RowDataManager (e.g. - * {@link io.deephaven.modelfarm.fitterfarm.futures.FuturesFitDataManager}). + * @param The type of keys. + * @param The type of data. + * @param The type of RowDataManager. */ public abstract class RDMModelFarm> extends ModelFarmBase { diff --git a/Plot/src/main/java/io/deephaven/plot/axistransformations/AxisTransform.java b/Plot/src/main/java/io/deephaven/plot/axistransformations/AxisTransform.java index 38a517a79bb..87667b3dc60 100644 --- a/Plot/src/main/java/io/deephaven/plot/axistransformations/AxisTransform.java +++ b/Plot/src/main/java/io/deephaven/plot/axistransformations/AxisTransform.java @@ -8,8 +8,8 @@ * * Determines how dataset values are displayed in the plot by transforming dataset values into Axis space and back. * - * For example, if the forward transform is x -> x^0.5, a dataset value of 1 maps to 1 in Axis space; a dataset value of - * 4 maps to 2. In the plot these values will be displayed close together. + * For example, if the forward transform is x -> x^0.5, a dataset value of 1 maps to 1 in Axis space; a dataset value + * of 4 maps to 2. In the plot these values will be displayed close together. */ public interface AxisTransform { diff --git a/Plot/src/main/java/io/deephaven/plot/datasets/DynamicSeriesNamer.java b/Plot/src/main/java/io/deephaven/plot/datasets/DynamicSeriesNamer.java index 6c08ea52134..38aa0ef676e 100644 --- a/Plot/src/main/java/io/deephaven/plot/datasets/DynamicSeriesNamer.java +++ b/Plot/src/main/java/io/deephaven/plot/datasets/DynamicSeriesNamer.java @@ -80,7 +80,7 @@ public synchronized String makeUnusedName(final String potentialName, final Plot * Gets all the series names.
* The order of series in 3D-plots are determined by returned set. * - * @return Set of seriesNames + * @return Set<String> of seriesNames */ public synchronized List getNames() { return Collections.unmodifiableList(namesList); diff --git a/Plot/src/main/java/io/deephaven/plot/datasets/category/CategoryDataSeries.java b/Plot/src/main/java/io/deephaven/plot/datasets/category/CategoryDataSeries.java index da3a0978594..5807cf65e07 100644 --- a/Plot/src/main/java/io/deephaven/plot/datasets/category/CategoryDataSeries.java +++ b/Plot/src/main/java/io/deephaven/plot/datasets/category/CategoryDataSeries.java @@ -166,7 +166,7 @@ public interface CategoryDataSeries extends DataSeries { * Sets the point color. Unspecified points use the default color. * * @param category data point - * @param color color + * @param pointColor color * @return this CategoryDataSeries */ CategoryDataSeries pointColor(final Comparable category, final Paint pointColor); diff --git a/Util/src/main/java/io/deephaven/test/types/ParallelTest.java b/Util/src/main/java/io/deephaven/test/types/ParallelTest.java index 5bb11791633..da3a1a792d1 100644 --- a/Util/src/main/java/io/deephaven/test/types/ParallelTest.java +++ b/Util/src/main/java/io/deephaven/test/types/ParallelTest.java @@ -14,10 +14,7 @@ * simple instance field, an @Rule instance field, or an @ClassRule static field) c-1) If your AdapterType has * setUp/tearDown, and you are not using @Rule or @ClassRule, annotate methods in your TestType: Add @Before/@After in * TestType which calls this.adapter.setUp()/tearDown() as appropriate. d) add an appropriate junit runner. If you do - * not need anything fancy, use: {@code @RunWith(org.junit.runners.BlockJUnit4ClassRunner.class)} - * - * If you extend and use our existing JUnit3 test fixtures like RefreshingTableTestCase, you can use - * {@link io.deephaven.test.junit4.JUnit4RefreshingTableTestCase} as an example. + * not need anything fancy, use: {@code @RunWith(org.junit.runners.BlockJUnit4ClassRunner.class)}. */ @SuppressWarnings("JavadocReference") public interface ParallelTest { diff --git a/Util/src/main/java/io/deephaven/test/types/SerialTest.java b/Util/src/main/java/io/deephaven/test/types/SerialTest.java index 4cf265ed115..de91187f83d 100644 --- a/Util/src/main/java/io/deephaven/test/types/SerialTest.java +++ b/Util/src/main/java/io/deephaven/test/types/SerialTest.java @@ -33,10 +33,7 @@ * simple instance field, an @Rule instance field, or an @ClassRule static field) c-1) If your AdapterType has * setUp/tearDown, and you are not using @Rule or @ClassRule, annotate methods in your TestType: Add @Before/@After in * TestType which calls this.adapter.setUp()/tearDown() as appropriate. d) add an appropriate junit runner. If you do - * not need anything fancy, use: {@code @RunWith(org.junit.runners.BlockJUnit4ClassRunner.class)} - * - * If you extend and use our existing JUnit3 test fixtures like RefreshingTableTestCase, you can use - * {@link io.deephaven.test.junit4.JUnit4RefreshingTableTestCase} as an example. + * not need anything fancy, use: {@code @RunWith(org.junit.runners.BlockJUnit4ClassRunner.class)}. */ @SuppressWarnings("JavadocReference") public interface SerialTest { diff --git a/Util/src/main/java/io/deephaven/util/audit/AuditEventLoggerBasic.java b/Util/src/main/java/io/deephaven/util/audit/AuditEventLoggerBasic.java deleted file mode 100644 index 809336e28c1..00000000000 --- a/Util/src/main/java/io/deephaven/util/audit/AuditEventLoggerBasic.java +++ /dev/null @@ -1,22 +0,0 @@ -/** - * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending - */ -package io.deephaven.util.audit; - -/** - * An simple interface that hides the context necessary for creating and logging {@link AuditEvent}s. Useful so that - * callers are only responsible for the core parts of the event, namely {@link AuditEvent#getEvent()} and - * {@link AuditEvent#getDetails()}. - */ -public interface AuditEventLoggerBasic { - void log(String event, String details); - - enum Null implements AuditEventLoggerBasic { - INSTANCE; - - @Override - public void log(String event, String details) { - // ignore - } - } -} diff --git a/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java b/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java index ae8d7c84cb7..a4be868dbea 100644 --- a/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java +++ b/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java @@ -102,8 +102,8 @@ public final boolean collect() { } /** - * Make an entry for a listener, in order to pass it to {@link #add(Object, Entry)}. May be called without holding - * any locks. + * Make an entry for a listener, in order to pass it to {@link #add(Object, SubscriptionSet.Entry)}. May be called + * without holding any locks. * * @param listener The listener * @return A new entry for the listener diff --git a/buildSrc/src/main/groovy/io.deephaven.java-publishing-conventions.gradle b/buildSrc/src/main/groovy/io.deephaven.java-publishing-conventions.gradle index df75e1ecbc0..e3ab87fa2c7 100644 --- a/buildSrc/src/main/groovy/io.deephaven.java-publishing-conventions.gradle +++ b/buildSrc/src/main/groovy/io.deephaven.java-publishing-conventions.gradle @@ -4,6 +4,7 @@ plugins { id 'java' id 'signing' id 'maven-publish' + id 'io.deephaven.javadoc-conventions' } java { @@ -12,9 +13,6 @@ java { } tasks.withType(Javadoc) { - options.addStringOption('Xdoclint:none', '-quiet') - options.addStringOption('Xmaxwarns', '1') - // https://github.com/gradle/gradle/issues/19869 options.addStringOption('sourcepath', sourceSets.main.allJava.getSourceDirectories().getAsPath()) } diff --git a/buildSrc/src/main/groovy/io.deephaven.java-shadow-publishing-conventions.gradle b/buildSrc/src/main/groovy/io.deephaven.java-shadow-publishing-conventions.gradle index acf3f404cea..0b4080f8923 100644 --- a/buildSrc/src/main/groovy/io.deephaven.java-shadow-publishing-conventions.gradle +++ b/buildSrc/src/main/groovy/io.deephaven.java-shadow-publishing-conventions.gradle @@ -5,6 +5,7 @@ plugins { id 'signing' id 'maven-publish' id 'com.github.johnrengelman.shadow' + id 'io.deephaven.javadoc-conventions' } java { @@ -13,9 +14,6 @@ java { } tasks.withType(Javadoc) { - options.addStringOption('Xdoclint:none', '-quiet') - options.addStringOption('Xmaxwarns', '1') - // https://github.com/gradle/gradle/issues/19869 options.addStringOption('sourcepath', sourceSets.main.allJava.getSourceDirectories().getAsPath()) } diff --git a/buildSrc/src/main/groovy/io.deephaven.javadoc-conventions.gradle b/buildSrc/src/main/groovy/io.deephaven.javadoc-conventions.gradle new file mode 100644 index 00000000000..1d7512ce4cd --- /dev/null +++ b/buildSrc/src/main/groovy/io.deephaven.javadoc-conventions.gradle @@ -0,0 +1,18 @@ +// Neither plain withType(Javadoc) {..} nor withType(Javadoc).all {..} will work here, somehow +// this breaks sourcesets in some projects. +tasks.withType(Javadoc).configureEach { + javadocTool = javaToolchains.javadocToolFor{javadocSpec -> + // Javadoc version >=11 is needed for search + // Javadoc version >12 is needed to avoid javadoc bugs in linking with modules + javadocSpec.languageVersion = JavaLanguageVersion.of(17) + } + + options.encoding = 'UTF-8' + + options.links = ['https://docs.oracle.com/en/java/javase/11/docs/api/'] + options.addBooleanOption('Xdoclint:none', true) + options.tags = ['apiNote', 'implNote', 'note'] + + // Don't fail on warnings, let specific projects enable this if desired +// options.addBooleanOption('Xwerror', true) +} diff --git a/combined-javadoc/build.gradle b/combined-javadoc/build.gradle index eab20cd5e16..f3001c6702e 100644 --- a/combined-javadoc/build.gradle +++ b/combined-javadoc/build.gradle @@ -26,19 +26,11 @@ def writeJavadocVersion = tasks.register 'writeJavadocVersion', { def allJavadoc = tasks.register 'allJavadoc', Javadoc, { Javadoc jdoc -> - // TODO(deephaven-core#1513): Remove non-LTS JDK 15 as part of javadocs process - jdoc.javadocTool = javaToolchains.javadocToolFor{it -> - // Javadoc version >=11 is needed for search - // Javadoc version >12 is needed to avoid javadoc bugs in linking with modules - languageVersion = JavaLanguageVersion.of(15) - } jdoc.inputs.file javaDocOverviewLocation - jdoc.options.encoding = 'UTF-8' - jdoc.options.tags = ['apiNote', 'implNote'] - // include a note on the front Javadoc page telling us what version the Javadoc was generated from. jdoc.options.overview = new File(javaDocOverviewLocation) - jdoc.options.links = ['https://docs.oracle.com/en/java/javase/11/docs/api/'] - jdoc.options.addStringOption('Xdoclint:none', '-quiet') + + // Fail on warnings to ensure correctness for our published docs + jdoc.options.addBooleanOption('Xwerror', true) def isForJavadocs = { Project p -> return io.deephaven.project.util.CombinedJavadoc.includeProject(p) } @@ -61,6 +53,8 @@ def allJavadoc = tasks.register 'allJavadoc', Javadoc, { jdoc.dependsOn(writeJavadocVersion) } +apply plugin: 'io.deephaven.javadoc-conventions' + artifacts { combinedJavadoc allJavadoc } diff --git a/engine/api/src/main/java/io/deephaven/engine/table/Table.java b/engine/api/src/main/java/io/deephaven/engine/table/Table.java index 5624bdbcd69..bcf29c2b5c0 100644 --- a/engine/api/src/main/java/io/deephaven/engine/table/Table.java +++ b/engine/api/src/main/java/io/deephaven/engine/table/Table.java @@ -216,9 +216,9 @@ public interface Table extends // ----------------------------------------------------------------------------------------------------------------- /** - * Retrieves a {@code ColumnSource}. It is conveniently cast to @{code ColumnSource} using the type that caller - * expects. This differs from {@link #getColumnSource(String, Class)} which uses the provided {@link Class} object - * to verify that the data type is a subclass of the expected class. + * Retrieves a {@code ColumnSource}. It is conveniently cast to {@code ColumnSource} using the type that + * caller expects. This differs from {@link #getColumnSource(String, Class)} which uses the provided {@link Class} + * object to verify that the data type is a subclass of the expected class. * * @param sourceName The name of the column * @param The target type, as a type parameter. Inferred from context. diff --git a/engine/api/src/main/java/io/deephaven/engine/table/WouldMatchPair.java b/engine/api/src/main/java/io/deephaven/engine/table/WouldMatchPair.java index 5c38ccb9124..ddb64db2f47 100644 --- a/engine/api/src/main/java/io/deephaven/engine/table/WouldMatchPair.java +++ b/engine/api/src/main/java/io/deephaven/engine/table/WouldMatchPair.java @@ -30,9 +30,9 @@ public WouldMatchPair(String columnName, String expression) { } /** - * Create a WouldMatchPair from a column name and {@link Filter} + * Create a WouldMatchPair from a column name and {@link Filter}. * - * @see SelectFilterFactory + * @see io.deephaven.engine.table.impl.select.WhereFilterFactory * * @param columnName the name of the resultant column * @param filter the filter to populate the column diff --git a/engine/chunk/src/main/java/io/deephaven/chunk/Chunk.java b/engine/chunk/src/main/java/io/deephaven/chunk/Chunk.java index 3bf98979f39..de855b0a240 100644 --- a/engine/chunk/src/main/java/io/deephaven/chunk/Chunk.java +++ b/engine/chunk/src/main/java/io/deephaven/chunk/Chunk.java @@ -51,8 +51,8 @@ interface Visitor { * Make a new Chunk that represents either exactly the same view on the underlying data as this Chunk, or a subrange * of that view. The view is defined as [0..size) (in the coordinate space of this Chunk). * - * @param offset Offset of the new Chunk, relative to this Chunk. 0 ≤ offset ≤ this.size - * @param capacity Capacity and initial size of the new Chunk. 0 ≤ capacity ≤ this.size - {@code offset}. + * @param offset Offset of the new Chunk, relative to this Chunk. 0 ≤ offset ≤ this.size + * @param capacity Capacity and initial size of the new Chunk. 0 ≤ capacity ≤ this.size - {@code offset}. * @return The new Chunk. A new Chunk will always be returned, even if the Chunks represent the same view. */ Chunk slice(int offset, int capacity); diff --git a/engine/chunk/src/main/java/io/deephaven/chunk/ObjectChunk.java b/engine/chunk/src/main/java/io/deephaven/chunk/ObjectChunk.java index 2ac6dd09319..d5e92bdc29c 100644 --- a/engine/chunk/src/main/java/io/deephaven/chunk/ObjectChunk.java +++ b/engine/chunk/src/main/java/io/deephaven/chunk/ObjectChunk.java @@ -158,7 +158,7 @@ public static ObjectChunk * Advance the current iterator position until {@code currentValue()} is greater than or equal to `v`. The - * operation is a no-op (and returns true) if currentValue() is already >= 'v'. Returns true if the operation + * operation is a no-op (and returns true) if currentValue() is already >= 'v'. Returns true if the operation * was successful. Otherwise, returns false. In this case the iteration is over and the iterator is exhausted; * calls to {@code hasNext()} will return false, any other operation is undefined. *

@@ -368,8 +368,8 @@ interface SearchIterator extends Iterator { * @return -1 if the iterator was exhausted at entry or the target was to the left of the initial position at * the time of the call, in which case the iterator is not changed; the resulting current position * otherwise. In this later case the current position is guaranteed to satisfy comp.compareTargetTo(v, - * dir) >= 0 and if also comp.compareTargetTo(v, dir) > 0, then v is the biggest such value for which - * comp.compareTargetTo(v, dir) > 0. + * dir) >= 0 and if also comp.compareTargetTo(v, dir) > 0, then v is the biggest such value for + * which comp.compareTargetTo(v, dir) > 0. */ long binarySearchValue(TargetComparator comp, int dir); } diff --git a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/RefCountedCow.java b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/RefCountedCow.java index a15e8adf892..c7f4db491ff 100644 --- a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/RefCountedCow.java +++ b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/RefCountedCow.java @@ -27,7 +27,7 @@ *

* *
- * {@Code
+ * {@code
  *
  *   class MyType extends RefCountedCow {
  *       @Override protected MyType self() { return this; }
diff --git a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspArray.java b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspArray.java
index 5e2bc2b95db..2c9a105f0cc 100644
--- a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspArray.java
+++ b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspArray.java
@@ -54,8 +54,8 @@
  *
  * 
    *
  • A "block" is a particular interval [n*2^16, (n+1)*2^16 - 1] of the long domain.
  • - *
  • A "span" is a partition of the domain consisting of one or more consecutive blocks;
  • a span is a subset of - * the domain represented by an interval [n*2^16, (n+m)*2^16 - 1], m >= 1. + *
  • A "span" is a partition of the domain consisting of one or more consecutive blocks; a span is a subset of the + * domain represented by an interval [n*2^16, (n+m)*2^16 - 1], m >= 1. *
  • Full blocks are blocks whose domain are fully contained in the set, ie, the set contains every possible value in * the block's interval (as a bitmap, it would be "all ones").
  • *
  • Spans of full blocks are represented by a single "full blocks span" object (just a Long) which knows how many @@ -89,8 +89,8 @@ *

    * *

    - * There are two basic cases for a span: it is either a full blocks span, containing a >=1 number of full blocks, or it - * is a container, containing individual values in the particular 2^16 block corresponding to the span's key. + * There are two basic cases for a span: it is either a full blocks span, containing a >=1 number of full blocks, or + * it is a container, containing individual values in the particular 2^16 block corresponding to the span's key. *

    * *

    @@ -1163,7 +1163,7 @@ public interface SpanCursorForward extends SpanCursor { /** * Advances the pointer forward to the last span in the sequence whose interval range has a value v such that - * comp.directionToTargetFrom(v) >= 0. + * comp.directionToTargetFrom(v) >= 0. * * This operation is O(log(cardinality)). * diff --git a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspRangeIterator.java b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspRangeIterator.java index cba97d7a23f..74026a1e5c7 100644 --- a/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspRangeIterator.java +++ b/engine/rowset/src/main/java/io/deephaven/engine/rowset/impl/rsp/RspRangeIterator.java @@ -284,8 +284,8 @@ public boolean advance(final long key) { /** * Advance the current iterator (start) position to the rightmost (last) value v that maintains - * comp.directionToTargetFrom(v) >= 0. I.e, either hasNext() returns false after this call, or the next value in the - * iterator nv would be such that comp.directionToTargetFrom(nv) < 0. + * comp.directionToTargetFrom(v) >= 0. I.e, either hasNext() returns false after this call, or the next value in + * the iterator nv would be such that comp.directionToTargetFrom(nv) < 0. * * Note this method should be called only after calling hasNext() and next() at least once, eg, from a valid current * position in a non-empty and also non-exhausted iterator. diff --git a/engine/table/src/main/java/io/deephaven/engine/page/Page.java b/engine/table/src/main/java/io/deephaven/engine/page/Page.java index a3b7ef09ce8..1c35884c8a2 100644 --- a/engine/table/src/main/java/io/deephaven/engine/page/Page.java +++ b/engine/table/src/main/java/io/deephaven/engine/page/Page.java @@ -20,10 +20,10 @@ * Non overlapping pages can be collected together in a {@link PageStore}, which provides the {@link ChunkSource} * interface to the collection of all of its Pages. *

    - * There are two distinct use cases/types of pages. The first use case are {@code Page}s which always have a length() > - * 0. These store length() values, which can be assessed via the {@link ChunkSource} methods. Valid {@link RowSequence} - * passed to those methods will have their offset in the range [firstRowOffset(), firstRowOffset() + length()). Passing - * OrderKeys with offsets outside of this range will have undefined results. + * There are two distinct use cases/types of pages. The first use case are {@code Page}s which always have a length() + * > 0. These store length() values, which can be assessed via the {@link ChunkSource} methods. Valid + * {@link RowSequence} passed to those methods will have their offset in the range [firstRowOffset(), firstRowOffset() + + * length()). Passing OrderKeys with offsets outside of this range will have undefined results. *

    * The second use case will always have length() == 0 and firstRowOffset() == 0. These represent "Null" regions which * return a fixed value, typically a null value, for every {@link RowSequence} passed into the {@link ChunkSource} diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationRowLookup.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationRowLookup.java index b609a3e44e1..5b5872a41f7 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationRowLookup.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationRowLookup.java @@ -35,7 +35,7 @@ public interface AggregationRowLookup { *

    Multiple group-by columns
    *
    Compound keys are {@code Object[]} of (boxed, if needed) objects, in the order of the aggregation's group-by * columns
    - *

    + * *

    * All key fields must be reinterpreted to the appropriate primitive value before boxing. See * {@link io.deephaven.engine.table.impl.sources.ReinterpretUtils#maybeConvertToPrimitive}. diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/CopyingPermutedBlinkFirstOrLastChunkedOperator.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/CopyingPermutedBlinkFirstOrLastChunkedOperator.java index 38677e96153..476466929b2 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/CopyingPermutedBlinkFirstOrLastChunkedOperator.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/CopyingPermutedBlinkFirstOrLastChunkedOperator.java @@ -58,7 +58,7 @@ public final void startTrackingPrevValues() { *

    * This implementation proceeds chunk-wise in the following manner: *

      - *
    1. Get a chunk of destination slots + *
    2. Get a chunk of destination slots
    3. *
    4. Fill a chunk of source indices
    5. *
    6. Sort the chunk of source indices
    7. *
    8. For each input column: get a chunk of input values, permute it into a chunk of destination values, and then diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/join/dupexpand/DupExpandKernel.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/join/dupexpand/DupExpandKernel.java index cfbefb8141a..06c919e01d1 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/join/dupexpand/DupExpandKernel.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/join/dupexpand/DupExpandKernel.java @@ -39,7 +39,7 @@ static DupExpandKernel makeDupExpand(ChunkType chunkType) { * keyRunLengths chunk is parallel to the original chunkToExpand; it is never modified. * * @param expandedSize the sum of all entries in keyRunLengths - * @param chunkToExpand the values to expand in-place (this writable chunk must have capacity >= expandedSize) + * @param chunkToExpand the values to expand in-place (this writable chunk must have capacity >= expandedSize) * @param keyRunLengths the key run-lengths parallel to chunkToExpand */ void expandDuplicates(int expandedSize, WritableChunk chunkToExpand, diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/locations/TableDataService.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/locations/TableDataService.java index cde882809c6..6179ee63d22 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/locations/TableDataService.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/locations/TableDataService.java @@ -46,7 +46,7 @@ default String getName() { * Get a detailed description string. * * @return A description string - * @implNote Defaults to {@link #toString()} + * @implNote Defaults to {@link Object#toString()} */ default String describe() { return toString(); diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/remote/ConstructSnapshot.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/remote/ConstructSnapshot.java index c9e0ca891ad..bc0170e566f 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/remote/ConstructSnapshot.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/remote/ConstructSnapshot.java @@ -1301,8 +1301,8 @@ public static boolean serializeAllTable(boolean usePrev, *

      * Populate a BarrageMessage with the specified positions to snapshot and columns. *

      - * >Note that care must be taken while using this method to ensure the underlying table is locked or does not - * change, otherwise the resulting snapshot may be inconsistent. In general users should instead use + * Note that care must be taken while using this method to ensure the underlying table is locked or does not change, + * otherwise the resulting snapshot may be inconsistent. In general users should instead use * {@link #constructBackplaneSnapshot} for simple use cases or {@link #callDataSnapshotFunction} for more advanced * uses. * diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/select/FormulaColumn.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/select/FormulaColumn.java index a1f229cb58f..670b2ff1f51 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/select/FormulaColumn.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/select/FormulaColumn.java @@ -35,8 +35,8 @@ default boolean hasConstantValue() { } /** - * Returns true if the formula expression of the column has Array Access that conforms to "i +/- " or "ii - * +/- " . + * Returns true if the formula expression of the column has Array Access that conforms to "i +/- <constant>" + * or "ii +/- <constant>". * * @return true or false */ @@ -46,8 +46,8 @@ default boolean hasConstantArrayAccess() { /** * Returns a Pair object consisting of formula string and shift to column MatchPairs. If the column formula or - * expression has Array Access that conforms to "i +/- " or "ii +/- " . If there is a parsing - * error for the expression null is returned. + * expression has Array Access that conforms to "i +/- <constant>" or "ii +/- <constant>". If there is a + * parsing error for the expression null is returned. * * @return Pair of final formula string and shift to column MatchPairs. */ diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/sources/FillUnordered.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/sources/FillUnordered.java index f12a524e71b..604c565d368 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/sources/FillUnordered.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/sources/FillUnordered.java @@ -19,7 +19,7 @@ public interface FillUnordered { * *

            * destination.setSize(keys.size());
      -     * for (int ii = 0; ii < keys.size(); ++ii) {
      +     * for (int ii = 0; ii < keys.size(); ++ii) {
            *     destination.set(ii, get(keys.get(ii)));
            * }
            * 
      @@ -41,7 +41,7 @@ void fillChunkUnordered( * *
            * destination.setSize(keys.size());
      -     * for (int ii = 0; ii < keys.size(); ++ii) {
      +     * for (int ii = 0; ii < keys.size(); ++ii) {
            *     destination.set(ii, getPrev(keys.get(ii)));
            * }
            * 
      diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigDecimalEmStdOperator.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigDecimalEmStdOperator.java index 61e085865b2..2ec30bfc4c2 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigDecimalEmStdOperator.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigDecimalEmStdOperator.java @@ -21,7 +21,7 @@ * Compute an exponential moving standard deviation for a BigDecimal column source. The output is expressed as a * BigDecimal value and is computed using the following formula: * - * variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + * variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) * * This function is described in the following document: * @@ -58,7 +58,7 @@ public void accumulateCumulative(@NotNull final RowSequence inputKeys, curVariance = BigDecimal.ZERO; curVal = null; } else { - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) curVariance = opAlpha.multiply( curVariance.add( opOneMinusAlpha.multiply(input.subtract(curEma).pow(2, mathContext)), @@ -100,7 +100,7 @@ public void accumulateCumulative(@NotNull final RowSequence inputKeys, oneMinusAlpha = computeOneMinusAlpha(alpha); lastDt = dt; } - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) curVariance = alpha.multiply( curVariance.add( oneMinusAlpha.multiply(input.subtract(curEma).pow(2, mathContext)), diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigIntegerEmStdOperator.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigIntegerEmStdOperator.java index 3b0a71e0434..62ddb7865d4 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigIntegerEmStdOperator.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/updateby/emstd/BigIntegerEmStdOperator.java @@ -22,7 +22,7 @@ * Compute an exponential moving standard deviation for a BigInteger column source. The output is expressed as a * BigDecimal value and is computed using the following formula: * - * variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + * variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) * * This function is described in the following document: * @@ -59,7 +59,7 @@ public void accumulateCumulative(@NotNull final RowSequence inputKeys, curVariance = BigDecimal.ZERO; curVal = null; } else { - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) curVariance = opAlpha.multiply( curVariance.add( opOneMinusAlpha.multiply(decInput.subtract(curEma).pow(2, mathContext)), mathContext), @@ -101,7 +101,7 @@ public void accumulateCumulative(@NotNull final RowSequence inputKeys, oneMinusAlpha = computeOneMinusAlpha(alpha); lastDt = dt; } - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) curVariance = alpha.multiply( curVariance.add( oneMinusAlpha.multiply(decInput.subtract(curEma).pow(2, mathContext)), mathContext), diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/RuntimeMemory.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/RuntimeMemory.java index c2f82968d30..bdef8babbc5 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/RuntimeMemory.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/RuntimeMemory.java @@ -16,10 +16,11 @@ * Cache memory utilization. * *

      - * >Calling Runtime.getRuntime().freeMemory() is expensive; and we may do it a lot when we have automatically computed + * Calling Runtime.getRuntime().freeMemory() is expensive; and we may do it a lot when we have automatically computed * tables, such as in a partitionBy. Instead of calling the runtime directly from the performance instrumentation * framework, we call this class's methods; which cache the result for a configurable number of milliseconds to avoid - * repeated calls that are not likely any different./p> + * repeated calls that are not likely any different. + *

      * *

      * Additionally, we log our JVM heap usage on a regular basis; to enable users to quickly examine their worker logs and diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/TableTimeConversions.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/TableTimeConversions.java index 6ebd43cb554..021e2bc14d7 100644 --- a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/TableTimeConversions.java +++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/TableTimeConversions.java @@ -30,7 +30,7 @@ * *

        * baseTable = db.i("Market", "Trades")
      - *               .where("Date > 2021-10-01")
      + *               .where("Date > 2021-10-01")
        *
        * startTime = LocalTime.of(10,30,00)
        * endTime = LocalTime.of(16,30,00)
      diff --git a/engine/table/src/main/java/io/deephaven/engine/util/Formatter.java b/engine/table/src/main/java/io/deephaven/engine/util/Formatter.java
      index 2f9904ef1d2..c672a0adee8 100644
      --- a/engine/table/src/main/java/io/deephaven/engine/util/Formatter.java
      +++ b/engine/table/src/main/java/io/deephaven/engine/util/Formatter.java
      @@ -12,9 +12,9 @@
        */
       public class Formatter {
           /**
      -     * Add new lines and indentation to a String produced by {@link TableDataService#toString()}
      +     * Add new lines and indentation to a String produced by {@link Object#toString()}
            *
      -     * @param tdsStr the output of {@link TableDataService#toString()}
      +     * @param tdsStr the output of {@link Object#toString()}
            * @return the same string with newlines and tabs.
            */
           @ScriptApi
      diff --git a/engine/table/src/main/java/io/deephaven/engine/util/PythonScope.java b/engine/table/src/main/java/io/deephaven/engine/util/PythonScope.java
      index ac1f4010fa2..8368a8a3aef 100644
      --- a/engine/table/src/main/java/io/deephaven/engine/util/PythonScope.java
      +++ b/engine/table/src/main/java/io/deephaven/engine/util/PythonScope.java
      @@ -86,7 +86,7 @@ default boolean containsKey(String name) {
           }
       
           /**
      -     * Equivalent to {@link #getValueRaw(String)}.map({@link #convertValue(PyObj)})
      +     * Equivalent to {@link #getValueRaw(String)}.map({@link #convertValue(Object)})
            *
            * @param name the name of the python variable
            * @return the converted object value, or empty
      @@ -110,7 +110,7 @@ default  Optional getValue(String name, Class clazz) {
           }
       
           /**
      -     * Equivalent to {@link #getValue(String)}.map(x -> (T)x);
      +     * Equivalent to {@link #getValue(String)}.map(x -> (T)x);
            *
            * @param name the name of the python variable
            * @param  the return type
      @@ -123,7 +123,7 @@ default  Optional getValueUnchecked(String name) {
           }
       
           /**
      -     * Equivalent to {@link #getKeysRaw()}.map({@link #convertStringKey(PyObj)})
      +     * Equivalent to {@link #getKeysRaw()}.map({@link #convertStringKey(Object)})
            *
            * @return the string keys
            */
      @@ -133,8 +133,8 @@ default Stream getKeys() {
           }
       
           /**
      -     * Equivalent to {@link #getEntriesRaw()}, where the keys have been converted via {@link #convertStringKey(PyObj)}
      -     * and the values via {@link #convertValue(PyObj)}
      +     * Equivalent to {@link #getEntriesRaw()}, where the keys have been converted via {@link #convertStringKey(Object)}
      +     * and the values via {@link #convertValue(Object)}.
            *
            * @return the string keys and converted values
            */
      diff --git a/engine/table/src/main/java/io/deephaven/engine/util/file/FileHandle.java b/engine/table/src/main/java/io/deephaven/engine/util/file/FileHandle.java
      index 80fdfc78450..effdbfbbbcc 100644
      --- a/engine/table/src/main/java/io/deephaven/engine/util/file/FileHandle.java
      +++ b/engine/table/src/main/java/io/deephaven/engine/util/file/FileHandle.java
      @@ -203,7 +203,7 @@ public final int read(@NotNull final ByteBuffer destination) throws IOException
       
           /**
            * 

      - * Attempt to write {@code source.remaining(){} bytes, starting from {@code position} (0-indexed) in the file. + * Attempt to write {@code source.remaining()} bytes, starting from {@code position} (0-indexed) in the file. *

      * See {@link FileChannel#write(ByteBuffer, long)}. * diff --git a/engine/table/src/main/java/io/deephaven/engine/util/string/StringUtils.java b/engine/table/src/main/java/io/deephaven/engine/util/string/StringUtils.java index 698220fa709..3af9fc84dd2 100644 --- a/engine/table/src/main/java/io/deephaven/engine/util/string/StringUtils.java +++ b/engine/table/src/main/java/io/deephaven/engine/util/string/StringUtils.java @@ -122,7 +122,7 @@ public String getKey(@NotNull final VALUE_TYPE value) { * Generic accessor for the singleton StringKey instance. * * @param The type of the value for this key implementation - * @return A String->StringKeyedObject key representation instance. + * @return A String->StringKeyedObject key representation instance. */ @SuppressWarnings("unused") public static KeyedObjectKey.Basic stringKey() { @@ -149,7 +149,7 @@ public String getKey(@NotNull final VALUE_TYPE value) { * Generic accessor for the singleton NullSafeStringKey instance. * * @param The type of the value for this key implementation - * @return A String->StringKeyedObject key representation instance that supports null keys. + * @return A String->StringKeyedObject key representation instance that supports null keys. */ @SuppressWarnings("unused") public static KeyedObjectKey.NullSafeBasic nullSafeStringKey() { @@ -188,7 +188,7 @@ public String getKey(@NotNull final VALUE_TYPE value) { * Generic accessor for the singleton StringKeyedObjectKey instance. * * @param The type of the value for this key implementation - * @return A String->StringKeyedObject key representation instance. + * @return A String->StringKeyedObject key representation instance. */ @SuppressWarnings("unused") public static KeyedObjectKey.Basic stringKeyedObjectKey() { @@ -217,7 +217,7 @@ public String getKey(@NotNull final VALUE_TYPE value) { * Generic accessor for the singleton NullSafeStringKeyedObjectKey instance. * * @param The type of the value for this key implementation - * @return A String->StringKeyedObject key representation instance that supports null keys. + * @return A String->StringKeyedObject key representation instance that supports null keys. */ @SuppressWarnings("unused") public static KeyedObjectKey.NullSafeBasic nullSafeStringKeyedObjectKey() { @@ -262,7 +262,7 @@ public boolean equalKey(@NotNull final CharSequence key, @NotNull final VALUE_TY * Generic accessor for the singleton CharSequenceKey instance. * * @param The type of the value for this key implementation - * @return A CharSequence->StringKeyedObject key representation instance. + * @return A CharSequence->StringKeyedObject key representation instance. */ public static KeyedObjectKey charSequenceKey() { // noinspection unchecked @@ -307,7 +307,7 @@ public boolean equalKey(final CharSequence key, @NotNull final VALUE_TYPE value) * Generic accessor for the singleton CharSequenceKey instance, with support for null keys. * * @param The type of the value for this key implementation - * @return A CharSequence->StringKeyedObject key representation instance. + * @return A CharSequence->StringKeyedObject key representation instance. */ @SuppressWarnings("unused") public static KeyedObjectKey nullSafeCharSequenceKey() { diff --git a/engine/table/src/main/java/io/deephaven/libs/GroovyStaticImports.java b/engine/table/src/main/java/io/deephaven/libs/GroovyStaticImports.java index 941967ad098..4f99780eb8c 100644 --- a/engine/table/src/main/java/io/deephaven/libs/GroovyStaticImports.java +++ b/engine/table/src/main/java/io/deephaven/libs/GroovyStaticImports.java @@ -189,7 +189,7 @@ public class GroovyStaticImports { public static double avg( io.deephaven.vector.LongVector values ) {return Numeric.avg( values );} /** @see io.deephaven.function.Numeric#avg(io.deephaven.vector.ShortVector) */ public static double avg( io.deephaven.vector.ShortVector values ) {return Numeric.avg( values );} - /** @see io.deephaven.function.BinSearch#binSearchIndex(T[],T,io.deephaven.function.BinSearchAlgo) */ + /** @see io.deephaven.function.BinSearch#binSearchIndex(java.lang.Comparable[],java.lang.Comparable,io.deephaven.function.BinSearchAlgo) */ public static > int binSearchIndex( T[] values, T key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.binSearchIndex( values, key, choiceWhenEquals );} /** @see io.deephaven.function.BinSearch#binSearchIndex(byte[],byte,io.deephaven.function.BinSearchAlgo) */ public static int binSearchIndex( byte[] values, byte key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.binSearchIndex( values, key, choiceWhenEquals );} @@ -219,7 +219,7 @@ public class GroovyStaticImports { public static int binSearchIndex( io.deephaven.vector.LongVector values, long key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.binSearchIndex( values, key, choiceWhenEquals );} /** @see io.deephaven.function.BinSearch#binSearchIndex(io.deephaven.vector.ShortVector,short,io.deephaven.function.BinSearchAlgo) */ public static int binSearchIndex( io.deephaven.vector.ShortVector values, short key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.binSearchIndex( values, key, choiceWhenEquals );} - /** @see io.deephaven.function.BinSearch#binSearchIndex(io.deephaven.vector.ObjectVector,T,io.deephaven.function.BinSearchAlgo) */ + /** @see io.deephaven.function.BinSearch#binSearchIndex(io.deephaven.vector.ObjectVector,java.lang.Comparable,io.deephaven.function.BinSearchAlgo) */ public static > int binSearchIndex( io.deephaven.vector.ObjectVector values, T key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.binSearchIndex( values, key, choiceWhenEquals );} /** @see io.deephaven.function.Cast#castDouble(byte) */ public static double castDouble( byte value ) {return Cast.castDouble( value );} @@ -413,7 +413,7 @@ public class GroovyStaticImports { public static long clamp( long value, long min, long max ) {return Numeric.clamp( value, min, max );} /** @see io.deephaven.function.Numeric#clamp(short,short,short) */ public static short clamp( short value, short min, short max ) {return Numeric.clamp( value, min, max );} - /** @see io.deephaven.function.Basic#concat(T[][]) */ + /** @see io.deephaven.function.Basic#concat(java.lang.Object[][]) */ public static T[] concat( T[][] values ) {return Basic.concat( values );} /** @see io.deephaven.function.Basic#concat(io.deephaven.vector.ByteVector[]) */ public static byte[] concat( io.deephaven.vector.ByteVector[] values ) {return Basic.concat( values );} @@ -853,11 +853,11 @@ public class GroovyStaticImports { public static long countDistinct( io.deephaven.vector.LongVector values, boolean countNull ) {return Basic.countDistinct( values, countNull );} /** @see io.deephaven.function.Basic#countDistinct(io.deephaven.vector.ShortVector,boolean) */ public static long countDistinct( io.deephaven.vector.ShortVector values, boolean countNull ) {return Basic.countDistinct( values, countNull );} - /** @see io.deephaven.function.Basic#countDistinctObj(T[]) */ + /** @see io.deephaven.function.Basic#countDistinctObj(java.lang.Comparable[]) */ public static > long countDistinctObj( T[] values ) {return Basic.countDistinctObj( values );} /** @see io.deephaven.function.Basic#countDistinctObj(io.deephaven.vector.ObjectVector) */ public static > long countDistinctObj( io.deephaven.vector.ObjectVector values ) {return Basic.countDistinctObj( values );} - /** @see io.deephaven.function.Basic#countDistinctObj(T[],boolean) */ + /** @see io.deephaven.function.Basic#countDistinctObj(java.lang.Comparable[],boolean) */ public static > long countDistinctObj( T[] values, boolean countNull ) {return Basic.countDistinctObj( values, countNull );} /** @see io.deephaven.function.Basic#countDistinctObj(io.deephaven.vector.ObjectVector,boolean) */ public static > long countDistinctObj( io.deephaven.vector.ObjectVector values, boolean countNull ) {return Basic.countDistinctObj( values, countNull );} @@ -897,7 +897,7 @@ public class GroovyStaticImports { public static long countNeg( io.deephaven.vector.LongVector values ) {return Numeric.countNeg( values );} /** @see io.deephaven.function.Numeric#countNeg(io.deephaven.vector.ShortVector) */ public static long countNeg( io.deephaven.vector.ShortVector values ) {return Numeric.countNeg( values );} - /** @see io.deephaven.function.Basic#countObj(T[]) */ + /** @see io.deephaven.function.Basic#countObj(java.lang.Object[]) */ public static long countObj( T[] values ) {return Basic.countObj( values );} /** @see io.deephaven.function.Basic#countObj(io.deephaven.vector.ObjectVector) */ public static long countObj( io.deephaven.vector.ObjectVector values ) {return Basic.countObj( values );} @@ -1461,11 +1461,11 @@ public class GroovyStaticImports { public static long[] distinct( io.deephaven.vector.LongVector values, boolean includeNull ) {return Basic.distinct( values, includeNull );} /** @see io.deephaven.function.Basic#distinct(io.deephaven.vector.ShortVector,boolean) */ public static short[] distinct( io.deephaven.vector.ShortVector values, boolean includeNull ) {return Basic.distinct( values, includeNull );} - /** @see io.deephaven.function.Basic#distinctObj(T[]) */ + /** @see io.deephaven.function.Basic#distinctObj(java.lang.Comparable[]) */ public static > T[] distinctObj( T[] values ) {return Basic.distinctObj( values );} /** @see io.deephaven.function.Basic#distinctObj(io.deephaven.vector.ObjectVector) */ public static > T[] distinctObj( io.deephaven.vector.ObjectVector values ) {return Basic.distinctObj( values );} - /** @see io.deephaven.function.Basic#distinctObj(T[],boolean) */ + /** @see io.deephaven.function.Basic#distinctObj(java.lang.Comparable[],boolean) */ public static > T[] distinctObj( T[] values, boolean includeNull ) {return Basic.distinctObj( values, includeNull );} /** @see io.deephaven.function.Basic#distinctObj(io.deephaven.vector.ObjectVector,boolean) */ public static > T[] distinctObj( io.deephaven.vector.ObjectVector values, boolean includeNull ) {return Basic.distinctObj( values, includeNull );} @@ -1551,11 +1551,11 @@ public class GroovyStaticImports { public static long firstIndexOf( short val, short[] values ) {return Basic.firstIndexOf( val, values );} /** @see io.deephaven.function.Basic#firstIndexOf(short,io.deephaven.vector.ShortVector) */ public static long firstIndexOf( short val, io.deephaven.vector.ShortVector values ) {return Basic.firstIndexOf( val, values );} - /** @see io.deephaven.function.Basic#firstIndexOfObj(T,T[]) */ + /** @see io.deephaven.function.Basic#firstIndexOfObj(java.lang.Object,java.lang.Object[]) */ public static long firstIndexOfObj( T val, T[] values ) {return Basic.firstIndexOfObj( val, values );} - /** @see io.deephaven.function.Basic#firstIndexOfObj(T,io.deephaven.vector.ObjectVector) */ + /** @see io.deephaven.function.Basic#firstIndexOfObj(java.lang.Object,io.deephaven.vector.ObjectVector) */ public static long firstIndexOfObj( T val, io.deephaven.vector.ObjectVector values ) {return Basic.firstIndexOfObj( val, values );} - /** @see io.deephaven.function.Basic#firstObj(T[]) */ + /** @see io.deephaven.function.Basic#firstObj(java.lang.Object[]) */ public static T firstObj( T[] values ) {return Basic.firstObj( values );} /** @see io.deephaven.function.Basic#firstObj(io.deephaven.vector.ObjectVector) */ public static T firstObj( io.deephaven.vector.ObjectVector values ) {return Basic.firstObj( values );} @@ -1599,7 +1599,7 @@ public class GroovyStaticImports { public static long[] forwardFill( io.deephaven.vector.LongVector values ) {return Basic.forwardFill( values );} /** @see io.deephaven.function.Basic#forwardFill(io.deephaven.vector.ShortVector) */ public static short[] forwardFill( io.deephaven.vector.ShortVector values ) {return Basic.forwardFill( values );} - /** @see io.deephaven.function.Basic#forwardFillObj(T[]) */ + /** @see io.deephaven.function.Basic#forwardFillObj(java.lang.Object[]) */ public static T[] forwardFillObj( T[] values ) {return Basic.forwardFillObj( values );} /** @see io.deephaven.function.Basic#forwardFillObj(io.deephaven.vector.ObjectVector) */ public static T[] forwardFillObj( io.deephaven.vector.ObjectVector values ) {return Basic.forwardFillObj( values );} @@ -1673,13 +1673,13 @@ public class GroovyStaticImports { public static long[] ifelse( io.deephaven.vector.ObjectVector condition, long trueCase, long falseCase ) {return Basic.ifelse( condition, trueCase, falseCase );} /** @see io.deephaven.function.Basic#ifelse(io.deephaven.vector.ObjectVector,short,short) */ public static short[] ifelse( io.deephaven.vector.ObjectVector condition, short trueCase, short falseCase ) {return Basic.ifelse( condition, trueCase, falseCase );} - /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean[],T,T) */ + /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean[],java.lang.Object,java.lang.Object) */ public static T[] ifelseObj( java.lang.Boolean[] condition, T trueCase, T falseCase ) {return Basic.ifelseObj( condition, trueCase, falseCase );} - /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean[],T[],T[]) */ + /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean[],java.lang.Object[],java.lang.Object[]) */ public static T[] ifelseObj( java.lang.Boolean[] condition, T[] trueCase, T[] falseCase ) {return Basic.ifelseObj( condition, trueCase, falseCase );} - /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean,T,T) */ + /** @see io.deephaven.function.Basic#ifelseObj(java.lang.Boolean,java.lang.Object,java.lang.Object) */ public static T ifelseObj( java.lang.Boolean condition, T trueCase, T falseCase ) {return Basic.ifelseObj( condition, trueCase, falseCase );} - /** @see io.deephaven.function.Basic#ifelseObj(io.deephaven.vector.ObjectVector,T,T) */ + /** @see io.deephaven.function.Basic#ifelseObj(io.deephaven.vector.ObjectVector,java.lang.Object,java.lang.Object) */ public static T[] ifelseObj( io.deephaven.vector.ObjectVector condition, T trueCase, T falseCase ) {return Basic.ifelseObj( condition, trueCase, falseCase );} /** @see io.deephaven.function.Basic#ifelseObj(io.deephaven.vector.ObjectVector,io.deephaven.vector.ObjectVector,io.deephaven.vector.ObjectVector) */ public static T[] ifelseObj( io.deephaven.vector.ObjectVector condition, io.deephaven.vector.ObjectVector trueCase, io.deephaven.vector.ObjectVector falseCase ) {return Basic.ifelseObj( condition, trueCase, falseCase );} @@ -1697,11 +1697,11 @@ public class GroovyStaticImports { public static boolean in( long testedValues, long[] possibleValues ) {return Basic.in( testedValues, possibleValues );} /** @see io.deephaven.function.Basic#in(short,short[]) */ public static boolean in( short testedValues, short[] possibleValues ) {return Basic.in( testedValues, possibleValues );} - /** @see io.deephaven.function.Basic#inObj(T,T[]) */ + /** @see io.deephaven.function.Basic#inObj(java.lang.Object,java.lang.Object[]) */ public static boolean inObj( T testedValue, T[] possibleValues ) {return Basic.inObj( testedValue, possibleValues );} - /** @see io.deephaven.function.Basic#inObj(T,io.deephaven.vector.ObjectVector) */ + /** @see io.deephaven.function.Basic#inObj(java.lang.Object,io.deephaven.vector.ObjectVector) */ public static boolean inObj( T testedValue, io.deephaven.vector.ObjectVector possibleValues ) {return Basic.inObj( testedValue, possibleValues );} - /** @see io.deephaven.function.Basic#inRange(T,T,T) */ + /** @see io.deephaven.function.Basic#inRange(java.lang.Comparable,java.lang.Comparable,java.lang.Comparable) */ public static > boolean inRange( T testedValue, T lowInclusiveValue, T highInclusiveValue ) {return Basic.inRange( testedValue, lowInclusiveValue, highInclusiveValue );} /** @see io.deephaven.function.Basic#inRange(byte,byte,byte) */ public static boolean inRange( byte testedValue, byte lowInclusiveValue, byte highInclusiveValue ) {return Basic.inRange( testedValue, lowInclusiveValue, highInclusiveValue );} @@ -1753,7 +1753,7 @@ public class GroovyStaticImports { public static long indexOfMax( io.deephaven.vector.LongVector values ) {return Numeric.indexOfMax( values );} /** @see io.deephaven.function.Numeric#indexOfMax(io.deephaven.vector.ShortVector) */ public static long indexOfMax( io.deephaven.vector.ShortVector values ) {return Numeric.indexOfMax( values );} - /** @see io.deephaven.function.Numeric#indexOfMaxObj(T[]) */ + /** @see io.deephaven.function.Numeric#indexOfMaxObj(java.lang.Comparable[]) */ public static > long indexOfMaxObj( T[] values ) {return Numeric.indexOfMaxObj( values );} /** @see io.deephaven.function.Numeric#indexOfMaxObj(io.deephaven.vector.ObjectVector) */ public static > long indexOfMaxObj( io.deephaven.vector.ObjectVector values ) {return Numeric.indexOfMaxObj( values );} @@ -1793,7 +1793,7 @@ public class GroovyStaticImports { public static long indexOfMin( io.deephaven.vector.LongVector values ) {return Numeric.indexOfMin( values );} /** @see io.deephaven.function.Numeric#indexOfMin(io.deephaven.vector.ShortVector) */ public static long indexOfMin( io.deephaven.vector.ShortVector values ) {return Numeric.indexOfMin( values );} - /** @see io.deephaven.function.Numeric#indexOfMinObj(T[]) */ + /** @see io.deephaven.function.Numeric#indexOfMinObj(java.lang.Comparable[]) */ public static > long indexOfMinObj( T[] values ) {return Numeric.indexOfMinObj( values );} /** @see io.deephaven.function.Numeric#indexOfMinObj(io.deephaven.vector.ObjectVector) */ public static > long indexOfMinObj( io.deephaven.vector.ObjectVector values ) {return Numeric.indexOfMinObj( values );} @@ -1869,7 +1869,7 @@ public class GroovyStaticImports { public static boolean isNaN( long value ) {return Numeric.isNaN( value );} /** @see io.deephaven.function.Numeric#isNaN(short) */ public static boolean isNaN( short value ) {return Numeric.isNaN( value );} - /** @see io.deephaven.function.Basic#isNull(T) */ + /** @see io.deephaven.function.Basic#isNull(java.lang.Object) */ public static boolean isNull( T value ) {return Basic.isNull( value );} /** @see io.deephaven.function.Basic#isNull(byte) */ public static boolean isNull( byte value ) {return Basic.isNull( value );} @@ -1913,11 +1913,11 @@ public class GroovyStaticImports { public static long last( io.deephaven.vector.LongVector values ) {return Basic.last( values );} /** @see io.deephaven.function.Basic#last(io.deephaven.vector.ShortVector) */ public static short last( io.deephaven.vector.ShortVector values ) {return Basic.last( values );} - /** @see io.deephaven.function.Basic#lastObj(T[]) */ + /** @see io.deephaven.function.Basic#lastObj(java.lang.Object[]) */ public static T lastObj( T[] values ) {return Basic.lastObj( values );} /** @see io.deephaven.function.Basic#lastObj(io.deephaven.vector.ObjectVector) */ public static T lastObj( io.deephaven.vector.ObjectVector values ) {return Basic.lastObj( values );} - /** @see io.deephaven.function.Basic#len(T[]) */ + /** @see io.deephaven.function.Basic#len(java.lang.Object[]) */ public static long len( T[] values ) {return Basic.len( values );} /** @see io.deephaven.function.Basic#len(byte[]) */ public static long len( byte[] values ) {return Basic.len( values );} @@ -2007,7 +2007,7 @@ public class GroovyStaticImports { public static long max( io.deephaven.vector.LongVector values ) {return Numeric.max( values );} /** @see io.deephaven.function.Numeric#max(io.deephaven.vector.ShortVector) */ public static short max( io.deephaven.vector.ShortVector values ) {return Numeric.max( values );} - /** @see io.deephaven.function.Numeric#maxObj(T[]) */ + /** @see io.deephaven.function.Numeric#maxObj(java.lang.Comparable[]) */ public static > T maxObj( T[] values ) {return Numeric.maxObj( values );} /** @see io.deephaven.function.Numeric#maxObj(io.deephaven.vector.ObjectVector) */ public static > T maxObj( io.deephaven.vector.ObjectVector values ) {return Numeric.maxObj( values );} @@ -2083,7 +2083,7 @@ public class GroovyStaticImports { public static long min( io.deephaven.vector.LongVector values ) {return Numeric.min( values );} /** @see io.deephaven.function.Numeric#min(io.deephaven.vector.ShortVector) */ public static short min( io.deephaven.vector.ShortVector values ) {return Numeric.min( values );} - /** @see io.deephaven.function.Numeric#minObj(T[]) */ + /** @see io.deephaven.function.Numeric#minObj(java.lang.Comparable[]) */ public static > T minObj( T[] values ) {return Numeric.minObj( values );} /** @see io.deephaven.function.Numeric#minObj(io.deephaven.vector.ObjectVector) */ public static > T minObj( io.deephaven.vector.ObjectVector values ) {return Numeric.minObj( values );} @@ -2119,7 +2119,7 @@ public class GroovyStaticImports { public static long nth( long index, io.deephaven.vector.LongVector values ) {return Basic.nth( index, values );} /** @see io.deephaven.function.Basic#nth(long,io.deephaven.vector.ShortVector) */ public static short nth( long index, io.deephaven.vector.ShortVector values ) {return Basic.nth( index, values );} - /** @see io.deephaven.function.Basic#nthObj(long,T[]) */ + /** @see io.deephaven.function.Basic#nthObj(long,java.lang.Object[]) */ public static T nthObj( long index, T[] values ) {return Basic.nthObj( index, values );} /** @see io.deephaven.function.Basic#nthObj(long,io.deephaven.vector.ObjectVector) */ public static T nthObj( long index, io.deephaven.vector.ObjectVector values ) {return Basic.nthObj( index, values );} @@ -2307,7 +2307,7 @@ public class GroovyStaticImports { public static long randomLong( long min, long max ) {return Random.randomLong( min, max );} /** @see io.deephaven.function.Random#randomLong(long,long,int) */ public static long[] randomLong( long min, long max, int size ) {return Random.randomLong( min, max, size );} - /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(T[],T,io.deephaven.function.BinSearchAlgo) */ + /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(java.lang.Comparable[],java.lang.Comparable,io.deephaven.function.BinSearchAlgo) */ public static > int rawBinSearchIndex( T[] values, T key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.rawBinSearchIndex( values, key, choiceWhenEquals );} /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(byte[],byte,io.deephaven.function.BinSearchAlgo) */ public static int rawBinSearchIndex( byte[] values, byte key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.rawBinSearchIndex( values, key, choiceWhenEquals );} @@ -2337,9 +2337,9 @@ public class GroovyStaticImports { public static int rawBinSearchIndex( io.deephaven.vector.LongVector values, long key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.rawBinSearchIndex( values, key, choiceWhenEquals );} /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(io.deephaven.vector.ShortVector,short,io.deephaven.function.BinSearchAlgo) */ public static int rawBinSearchIndex( io.deephaven.vector.ShortVector values, short key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.rawBinSearchIndex( values, key, choiceWhenEquals );} - /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(io.deephaven.vector.ObjectVector,T,io.deephaven.function.BinSearchAlgo) */ + /** @see io.deephaven.function.BinSearch#rawBinSearchIndex(io.deephaven.vector.ObjectVector,java.lang.Comparable,io.deephaven.function.BinSearchAlgo) */ public static > int rawBinSearchIndex( io.deephaven.vector.ObjectVector values, T key, io.deephaven.function.BinSearchAlgo choiceWhenEquals ) {return BinSearch.rawBinSearchIndex( values, key, choiceWhenEquals );} - /** @see io.deephaven.function.Basic#repeat(T,int) */ + /** @see io.deephaven.function.Basic#repeat(java.lang.Object,int) */ public static T[] repeat( T value, int size ) {return Basic.repeat( value, size );} /** @see io.deephaven.function.Basic#repeat(byte,int) */ public static byte[] repeat( byte value, int size ) {return Basic.repeat( value, size );} @@ -2379,9 +2379,9 @@ public class GroovyStaticImports { public static double[] replaceIfNonFinite( io.deephaven.vector.DoubleVector values, double replacement ) {return Numeric.replaceIfNonFinite( values, replacement );} /** @see io.deephaven.function.Numeric#replaceIfNonFinite(io.deephaven.vector.FloatVector,float) */ public static float[] replaceIfNonFinite( io.deephaven.vector.FloatVector values, float replacement ) {return Numeric.replaceIfNonFinite( values, replacement );} - /** @see io.deephaven.function.Basic#replaceIfNull(T,T) */ + /** @see io.deephaven.function.Basic#replaceIfNull(java.lang.Object,java.lang.Object) */ public static T replaceIfNull( T value, T replacement ) {return Basic.replaceIfNull( value, replacement );} - /** @see io.deephaven.function.Basic#replaceIfNull(T[],T) */ + /** @see io.deephaven.function.Basic#replaceIfNull(java.lang.Object[],java.lang.Object) */ public static T[] replaceIfNull( T[] values, T replacement ) {return Basic.replaceIfNull( values, replacement );} /** @see io.deephaven.function.Basic#replaceIfNull(byte,byte) */ public static byte replaceIfNull( byte value, byte replacement ) {return Basic.replaceIfNull( value, replacement );} @@ -2421,7 +2421,7 @@ public class GroovyStaticImports { public static long[] replaceIfNull( io.deephaven.vector.LongVector values, long replacement ) {return Basic.replaceIfNull( values, replacement );} /** @see io.deephaven.function.Basic#replaceIfNull(io.deephaven.vector.ShortVector,short) */ public static short[] replaceIfNull( io.deephaven.vector.ShortVector values, short replacement ) {return Basic.replaceIfNull( values, replacement );} - /** @see io.deephaven.function.Basic#replaceIfNull(io.deephaven.vector.ObjectVector,T) */ + /** @see io.deephaven.function.Basic#replaceIfNull(io.deephaven.vector.ObjectVector,java.lang.Object) */ public static T[] replaceIfNull( io.deephaven.vector.ObjectVector values, T replacement ) {return Basic.replaceIfNull( values, replacement );} /** @see io.deephaven.function.Basic#replaceIfNull(long,long) */ public static long replaceIfNull( long value, long replacement ) {return Basic.replaceIfNull( value, replacement );} @@ -2467,7 +2467,7 @@ public class GroovyStaticImports { public static long[] reverse( io.deephaven.vector.LongVector values ) {return Basic.reverse( values );} /** @see io.deephaven.function.Basic#reverse(io.deephaven.vector.ShortVector) */ public static short[] reverse( io.deephaven.vector.ShortVector values ) {return Basic.reverse( values );} - /** @see io.deephaven.function.Basic#reverseObj(T[]) */ + /** @see io.deephaven.function.Basic#reverseObj(java.lang.Object[]) */ public static T[] reverseObj( T[] values ) {return Basic.reverseObj( values );} /** @see io.deephaven.function.Basic#reverseObj(io.deephaven.vector.ObjectVector) */ public static T[] reverseObj( io.deephaven.vector.ObjectVector values ) {return Basic.reverseObj( values );} @@ -2603,19 +2603,19 @@ public class GroovyStaticImports { public static long[] sortDescending( io.deephaven.vector.LongVector values ) {return Sort.sortDescending( values );} /** @see io.deephaven.function.Sort#sortDescending(io.deephaven.vector.ShortVector) */ public static short[] sortDescending( io.deephaven.vector.ShortVector values ) {return Sort.sortDescending( values );} - /** @see io.deephaven.function.Sort#sortDescendingObj(T[]) */ + /** @see io.deephaven.function.Sort#sortDescendingObj(java.lang.Comparable[]) */ public static > T[] sortDescendingObj( T[] values ) {return Sort.sortDescendingObj( values );} /** @see io.deephaven.function.Sort#sortDescendingObj(io.deephaven.vector.ObjectVector) */ public static > T[] sortDescendingObj( io.deephaven.vector.ObjectVector values ) {return Sort.sortDescendingObj( values );} - /** @see io.deephaven.function.Sort#sortDescendingObj(T[],java.util.Comparator) */ + /** @see io.deephaven.function.Sort#sortDescendingObj(java.lang.Comparable[],java.util.Comparator) */ public static > T[] sortDescendingObj( T[] values, java.util.Comparator comparator ) {return Sort.sortDescendingObj( values, comparator );} /** @see io.deephaven.function.Sort#sortDescendingObj(io.deephaven.vector.ObjectVector,java.util.Comparator) */ public static > T[] sortDescendingObj( io.deephaven.vector.ObjectVector values, java.util.Comparator comparator ) {return Sort.sortDescendingObj( values, comparator );} - /** @see io.deephaven.function.Sort#sortObj(T[]) */ + /** @see io.deephaven.function.Sort#sortObj(java.lang.Comparable[]) */ public static > T[] sortObj( T[] values ) {return Sort.sortObj( values );} /** @see io.deephaven.function.Sort#sortObj(io.deephaven.vector.ObjectVector) */ public static > T[] sortObj( io.deephaven.vector.ObjectVector values ) {return Sort.sortObj( values );} - /** @see io.deephaven.function.Sort#sortObj(T[],java.util.Comparator) */ + /** @see io.deephaven.function.Sort#sortObj(java.lang.Comparable[],java.util.Comparator) */ public static > T[] sortObj( T[] values, java.util.Comparator comparator ) {return Sort.sortObj( values, comparator );} /** @see io.deephaven.function.Sort#sortObj(io.deephaven.vector.ObjectVector,java.util.Comparator) */ public static > T[] sortObj( io.deephaven.vector.ObjectVector values, java.util.Comparator comparator ) {return Sort.sortObj( values, comparator );} @@ -2863,7 +2863,7 @@ public class GroovyStaticImports { public static io.deephaven.vector.LongVector vec( long[] values ) {return Basic.vec( values );} /** @see io.deephaven.function.Basic#vec(short[]) */ public static io.deephaven.vector.ShortVector vec( short[] values ) {return Basic.vec( values );} - /** @see io.deephaven.function.Basic#vecObj(T[]) */ + /** @see io.deephaven.function.Basic#vecObj(java.lang.Object[]) */ public static io.deephaven.vector.ObjectVector vecObj( T[] values ) {return Basic.vecObj( values );} /** @see io.deephaven.function.Numeric#wavg(byte[],byte[]) */ public static double wavg( byte[] values, byte[] weights ) {return Numeric.wavg( values, weights );} diff --git a/engine/table/src/test/java/io/deephaven/engine/table/impl/updateby/TestEmStd.java b/engine/table/src/test/java/io/deephaven/engine/table/impl/updateby/TestEmStd.java index 1a338d9fbae..f29aaffd115 100644 --- a/engine/table/src/test/java/io/deephaven/engine/table/impl/updateby/TestEmStd.java +++ b/engine/table/src/test/java/io/deephaven/engine/table/impl/updateby/TestEmStd.java @@ -917,7 +917,7 @@ public static double[] compute_emstd_ticks(OperationControl control, long ticks, runningVariance = 0.0; outputVal = Double.NaN; } else { - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) runningVariance = alpha * (runningVariance + oneMinusAlpha * Math.pow(values[i] - runningEma, 2.0)); final double decayedEmaVal = runningEma * alpha; @@ -961,7 +961,7 @@ public static BigDecimal[] compute_emstd_ticks(OperationControl control, long ti runningVariance = BigDecimal.ZERO; outputVal = null; } else { - // incremental variance = alpha * (prevVariance + (1 − alpha) * (x − prevEma)^2) + // incremental variance = alpha * (prevVariance + (1 - alpha) * (x - prevEma)^2) runningVariance = alpha.multiply( runningVariance.add( oneMinusAlpha.multiply(values[i].subtract(runningEma).pow(2, mathContextDefault)), @@ -1027,7 +1027,7 @@ public static double[] compute_emstd_time(OperationControl control, long nanos, final double alpha = Math.exp(-dt / (double) nanos); final double oneMinusAlpha = 1.0 - alpha; - // incremental variance = (1 − alpha)(prevVariance + alpha * (x − prevEma)^2) + // incremental variance = (1 - alpha)(prevVariance + alpha * (x - prevEma)^2) runningVariance = alpha * (runningVariance + oneMinusAlpha * Math.pow(values[i] - runningEma, 2.0)); final double decayedEmaVal = runningEma * alpha; diff --git a/engine/updategraph/src/main/java/io/deephaven/engine/updategraph/UpdateGraphProcessor.java b/engine/updategraph/src/main/java/io/deephaven/engine/updategraph/UpdateGraphProcessor.java index a448ba1622d..0aaba5c8f62 100644 --- a/engine/updategraph/src/main/java/io/deephaven/engine/updategraph/UpdateGraphProcessor.java +++ b/engine/updategraph/src/main/java/io/deephaven/engine/updategraph/UpdateGraphProcessor.java @@ -54,8 +54,8 @@ *

      * This class can be configured via the following {@link Configuration} property *

        - *
      • {@value DEFAULT_TARGET_CYCLE_DURATION_MILLIS_PROP}(optional) - The default target cycle time in ms (1000 if - * not defined)
      • + *
      • {@value DEFAULT_TARGET_CYCLE_DURATION_MILLIS_PROP}(optional) - The default target cycle time in ms (1000 if not + * defined)
      • *
      */ public enum UpdateGraphProcessor implements UpdateSourceRegistrar, NotificationQueue, NotificationQueue.Dependency { diff --git a/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/BarragePerformanceLog.java b/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/BarragePerformanceLog.java index 0061e529cd5..467f44401c1 100644 --- a/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/BarragePerformanceLog.java +++ b/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/BarragePerformanceLog.java @@ -22,13 +22,13 @@ /** * Enable barrage performance metrics by setting the {@code BarragePerformanceLog.enableAll} configuration property, or * by adding the {@link io.deephaven.engine.table.Table#BARRAGE_PERFORMANCE_KEY_ATTRIBUTE table key} as an - * {@link io.deephaven.engine.table.Table#withAttributes(Map) attribute} to the table. + * {@link Table#withAttributes(Map)} attribute} to the table. */ public class BarragePerformanceLog { /** * If all barrage performance logging is enabled by default, then table's description is used as TableKey unless * overridden with the {@link io.deephaven.engine.table.Table#BARRAGE_PERFORMANCE_KEY_ATTRIBUTE table key} - * {@link io.deephaven.engine.table.Table#withAttributes(Map) attribute}. + * {@link Table#withAttributes(Map)} attribute}. */ public static final boolean ALL_PERFORMANCE_ENABLED = Configuration.getInstance().getBooleanForClassWithDefault( BarragePerformanceLog.class, "enableAll", true); diff --git a/extensions/jdbc/src/main/java/io/deephaven/jdbc/JdbcToTableAdapter.java b/extensions/jdbc/src/main/java/io/deephaven/jdbc/JdbcToTableAdapter.java index 83181f417f2..ec672ab8a4f 100644 --- a/extensions/jdbc/src/main/java/io/deephaven/jdbc/JdbcToTableAdapter.java +++ b/extensions/jdbc/src/main/java/io/deephaven/jdbc/JdbcToTableAdapter.java @@ -38,10 +38,11 @@ /** * The JdbcToTableAdapter class provides a simple interface to convert a Java Database Connectivity (JDBC) * {@link ResultSet} to a Deephaven {@link Table}. - *

      * + *

      * To use, first create a result set using your provided JDBC driver of choice: - * + *

      + * *
        * Connection connection = DriverManager.getConnection("jdbc:sqlite:/path/to/db.sqlite");
        * Statement statement = connection.createStatement();
      diff --git a/extensions/kafka/src/main/java/io/deephaven/kafka/CdcTools.java b/extensions/kafka/src/main/java/io/deephaven/kafka/CdcTools.java
      index 448948764cb..96875566a94 100644
      --- a/extensions/kafka/src/main/java/io/deephaven/kafka/CdcTools.java
      +++ b/extensions/kafka/src/main/java/io/deephaven/kafka/CdcTools.java
      @@ -204,7 +204,7 @@ public static CdcSpec cdcLongSpec(
            * @param topic The Kafka topic for the CDC events associated to the desired table data.
            * @param keySchemaName The schema name for the Key Kafka field in the CDC events for the topic. This schema should
            *        include definitions for the columns forming the PRIMARY KEY of the underlying table.
      -     * @parar keySchemaVersion The version for the Key schema to look up in schema server.
      +     * @param keySchemaVersion The version for the Key schema to look up in schema server.
            * @param valueSchemaName The schema name for the Value Kafka field in the CDC events for the topic. This schema
            *        should include definitions for all the columns of the underlying table.
            * @param valueSchemaVersion The version for the Value schema to look up in schema server.
      diff --git a/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java b/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java
      index 5e20e0fad68..26646ac88cd 100644
      --- a/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java
      +++ b/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java
      @@ -994,8 +994,8 @@ public static KeyOrValueSpec simpleSpec(final String columnName) {
                * @param includeColumns An array with an entry for each column intended to be included in the JSON output. If
                *        null, include all columns except those specified in {@code excludeColumns}. If {@code includeColumns}
                *        is not null, {@code excludeColumns} should be null.
      -         * @param excludeColumns A set specifying column names to ommit; can only be used when {@columnNames} is null.
      -         *        In this case all table columns except for the ones in {@code excludeColumns} will be included.
      +         * @param excludeColumns A set specifying column names to omit; can only be used when {@code columnNames} is
      +         *        null. In this case all table columns except for the ones in {@code excludeColumns} will be included.
                * @param columnToFieldMapping A map from column name to JSON field name to use for that column. Any column
                *        names implied by earlier arguments not included as a key in the map will be mapped to JSON fields of
                *        the same name. If null, map all columns to fields of the same name.
      @@ -1038,8 +1038,9 @@ public static KeyOrValueSpec jsonSpec(
                * @param includeColumns An array with an entry for each column intended to be included in the JSON output. If
                *        null, include all columns except those specified in {@code excludeColumns}. If {@code includeColumns}
                *        is not null, {@code excludeColumns} should be null.
      -         * @param excludeColumns A predicate specifying column names to ommit; can only be used when {@columnNames} is
      -         *        null. In this case all table columns except for the ones in {@code excludeColumns} will be included.
      +         * @param excludeColumns A predicate specifying column names to omit; can only be used when {@code columnNames}
      +         *        is null. In this case all table columns except for the ones in {@code excludeColumns} will be
      +         *        included.
                * @param columnToFieldMapping A map from column name to JSON field name to use for that column. Any column
                *        names implied by earlier arguments not included as a key in the map will be mapped to JSON fields of
                *        the same name. If null, map all columns to fields of the same name.
      diff --git a/extensions/kafka/src/main/java/io/deephaven/kafka/ingest/KafkaIngester.java b/extensions/kafka/src/main/java/io/deephaven/kafka/ingest/KafkaIngester.java
      index a9f80358b59..a2d980a27d9 100644
      --- a/extensions/kafka/src/main/java/io/deephaven/kafka/ingest/KafkaIngester.java
      +++ b/extensions/kafka/src/main/java/io/deephaven/kafka/ingest/KafkaIngester.java
      @@ -160,7 +160,7 @@ public String toString() {
            * @param topic The topic to replicate
            * @param partitionToStreamConsumer A function implementing a mapping from partition to its consumer of records. The
            *        function will be invoked once per partition at construction; implementations should internally defer
      -     *        resource allocation until first call to {@link KafkaStreamConsumer#consume(Object)} or
      +     *        resource allocation until first call to {@link KafkaStreamConsumer#consume(List)} or
            *        {@link KafkaStreamConsumer#acceptFailure(Throwable)} if appropriate.
            * @param partitionToInitialSeekOffset A function implementing a mapping from partition to its initial seek offset,
            *        or -1 if seek to beginning is intended.
      @@ -189,7 +189,7 @@ public KafkaIngester(final Logger log,
            * @param partitionFilter A predicate indicating which partitions we should replicate
            * @param partitionToStreamConsumer A function implementing a mapping from partition to its consumer of records. The
            *        function will be invoked once per partition at construction; implementations should internally defer
      -     *        resource allocation until first call to {@link KafkaStreamConsumer#consume(Object)} or
      +     *        resource allocation until first call to {@link KafkaStreamConsumer#consume(List)} or
            *        {@link KafkaStreamConsumer#acceptFailure(Throwable)} if appropriate.
            * @param partitionToInitialSeekOffset A function implementing a mapping from partition to its initial seek offset,
            *        or -1 if seek to beginning is intended.
      diff --git a/hotspot/src/main/java/io/deephaven/hotspot/JvmIntrospectionContext.java b/hotspot/src/main/java/io/deephaven/hotspot/JvmIntrospectionContext.java
      index bebfa716595..3db7232500e 100644
      --- a/hotspot/src/main/java/io/deephaven/hotspot/JvmIntrospectionContext.java
      +++ b/hotspot/src/main/java/io/deephaven/hotspot/JvmIntrospectionContext.java
      @@ -6,12 +6,15 @@
       /**
        * Utility class to facilitate obtaining data for safepoint pauses count and time between two points in code. A
        * safepoint pause is a "stop the world, pause all threads" event in the HotSpot JVM. Note full Garbage Collection
      - * pauses are a dominant cause of safepoint pauses, but there are other triggers like: 
      + * pauses are a dominant cause of safepoint pauses, but there are other triggers like:
      + * 
        *
      1. Deoptimization
      2. *
      3. Biased lock revocation
      4. *
      5. Thread dump
      6. - *
      7. Heap inspection< /li> - *
      8. Class redefinition
      9. And others; you can see a full list Heap inspection + *
      10. Class redefinition
      11. + *
      + * And others; you can see a full list * here . * diff --git a/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSnapshot.java b/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSnapshot.java index 3c2083b1816..746b4408f66 100644 --- a/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSnapshot.java +++ b/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSnapshot.java @@ -62,7 +62,8 @@ BarrageSnapshot snapshot(TableSpec tableSpec, BarrageSnapshotOptions options) * * @param viewport the position-space viewport to use for the snapshot * @param columns the columns to include in the snapshot - * @param reverseViewport Whether to treat {@code posRowSet} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code posRowSet} as offsets from + * {@link io.deephaven.engine.table.Table#size()} rather than {@code 0} * * @return the {@code BarrageTable} */ diff --git a/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSubscription.java b/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSubscription.java index 88d769a9c7e..8d68f52d0a9 100644 --- a/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSubscription.java +++ b/java-client/barrage/src/main/java/io/deephaven/client/impl/BarrageSubscription.java @@ -90,7 +90,8 @@ BarrageSubscription subscribe(TableSpec tableSpec, BarrageSubscriptionOptions op * * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code posRowSet} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code posRowSet} as offsets from + * {@link io.deephaven.engine.table.Table#size()} rather than {@code 0} * * @return the {@code BarrageTable} */ @@ -102,7 +103,8 @@ BarrageSubscription subscribe(TableSpec tableSpec, BarrageSubscriptionOptions op * * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code posRowSet} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code posRowSet} as offsets from + * {@link io.deephaven.engine.table.Table#size()} rather than {@code 0} * @param blockUntilComplete block execution until the subscribed table viewport is satisfied * * @return the {@code BarrageTable} @@ -146,7 +148,8 @@ BarrageTable partialTable(RowSet viewport, BitSet columns, boolean reverseViewpo * * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code posRowSet} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code posRowSet} as offsets from + * {@link io.deephaven.engine.table.Table#size()} rather than {@code 0} * * @return the {@code BarrageTable} */ @@ -159,7 +162,8 @@ BarrageTable snapshotPartialTable(RowSet viewport, BitSet columns, boolean rever * * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code posRowSet} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code posRowSet} as offsets from + * {@link io.deephaven.engine.table.Table#size()} rather than {@code 0} * @param blockUntilComplete block execution until the subscribed table viewport is satisfied * * @return the {@code BarrageTable} diff --git a/java-client/session/src/main/java/io/deephaven/client/impl/TableHandleManager.java b/java-client/session/src/main/java/io/deephaven/client/impl/TableHandleManager.java index 8205455ed68..f10073681e3 100644 --- a/java-client/session/src/main/java/io/deephaven/client/impl/TableHandleManager.java +++ b/java-client/session/src/main/java/io/deephaven/client/impl/TableHandleManager.java @@ -16,7 +16,8 @@ import java.util.List; /** - * A table handle manager is able to execute {@linkplain TableSpec tables}, {@link } + * A table handle manager is able to execute commands that produce tables, by accepting {@link TableSpec}s, + * {@link TableCreationLogic}s, and more. */ public interface TableHandleManager extends TableCreator { diff --git a/py/jpy-ext/src/main/java/io/deephaven/jpy/BuiltinsModule.java b/py/jpy-ext/src/main/java/io/deephaven/jpy/BuiltinsModule.java index 2d6c583a71a..028531218ea 100644 --- a/py/jpy-ext/src/main/java/io/deephaven/jpy/BuiltinsModule.java +++ b/py/jpy-ext/src/main/java/io/deephaven/jpy/BuiltinsModule.java @@ -41,7 +41,7 @@ static BuiltinsModule create() { * Create a new dictionary. * * @return the dictionary - * @see dict */ PyObject dict(); diff --git a/server/src/main/java/io/deephaven/server/config/ServerConfig.java b/server/src/main/java/io/deephaven/server/config/ServerConfig.java index b572b377044..82561fe838d 100644 --- a/server/src/main/java/io/deephaven/server/config/ServerConfig.java +++ b/server/src/main/java/io/deephaven/server/config/ServerConfig.java @@ -75,12 +75,14 @@ public interface ServerConfig { * * Also parses {@link MainHelper#parseSSLConfig(Configuration)} into {@link Builder#ssl(SSLConfig)} and * {@link MainHelper#parseOutboundSSLConfig(Configuration)} into {@link Builder#outboundSsl(SSLConfig)}. - * + *

      + * See {@link MainHelper#parseSSLConfig(Configuration)} for {@link Builder#ssl(SSLConfig)}. + *

      + * * @param builder the builder * @param config the configuration * @return the builder * @param the builder type - * @see MainHelper#parseSSLConfig(Configuration) for {@link Builder#ssl(SSLConfig)} */ static > B buildFromConfig(B builder, Configuration config) { int httpSessionExpireMs = config.getIntegerWithDefault(HTTP_SESSION_DURATION_MS, -1); diff --git a/server/src/main/java/io/deephaven/server/uri/BarrageTableResolver.java b/server/src/main/java/io/deephaven/server/uri/BarrageTableResolver.java index 8a9a25fd7d8..d69bbe38abc 100644 --- a/server/src/main/java/io/deephaven/server/uri/BarrageTableResolver.java +++ b/server/src/main/java/io/deephaven/server/uri/BarrageTableResolver.java @@ -169,7 +169,8 @@ public Table subscribe(String targetUri, TableSpec table, RowSet viewport, BitSe * @param table the table spec * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link Table#size()} rather than + * {@code 0} * @return the subscribed table */ public Table subscribe(String targetUri, TableSpec table, RowSet viewport, BitSet columns, boolean reverseViewport) @@ -186,7 +187,8 @@ public Table subscribe(String targetUri, TableSpec table, RowSet viewport, BitSe * @param options the options * @param viewport the position-space viewport to use for the subscription * @param columns the columns to include in the subscription - * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link Table#size()} rather than + * {@code 0} * @return the subscribed table */ public Table subscribe(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options, RowSet viewport, @@ -262,7 +264,8 @@ public Table snapshot(String targetUri, TableSpec table, RowSet viewport, BitSet * @param table the table spec * @param viewport the position-space viewport to use for the snapshot * @param columns the columns to include in the snapshot - * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link Table#size()} rather than + * {@code 0} * @return the table to snapshot */ public Table snapshot(String targetUri, TableSpec table, RowSet viewport, BitSet columns, boolean reverseViewport) @@ -279,7 +282,8 @@ public Table snapshot(String targetUri, TableSpec table, RowSet viewport, BitSet * @param options the options * @param viewport the position-space viewport to use for the snapshot * @param columns the columns to include in the snapshot - * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link #size()} rather than {@code 0} + * @param reverseViewport Whether to treat {@code viewport} as offsets from {@link Table#size()} rather than + * {@code 0} * @return the table to snapshot */ public Table snapshot(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options, RowSet viewport, diff --git a/ssl/config/src/main/java/io/deephaven/ssl/config/package-info.java b/ssl/config/src/main/java/io/deephaven/ssl/config/package-info.java index dba19431751..2ac8087976d 100644 --- a/ssl/config/src/main/java/io/deephaven/ssl/config/package-info.java +++ b/ssl/config/src/main/java/io/deephaven/ssl/config/package-info.java @@ -8,7 +8,7 @@ * JSON. It is meant to service the majority of server and client SSL configuration use-cases. * *

      - * While not exposed to the end-user, the overall configuration structure is guided by sslcontext-kickstart. */ package io.deephaven.ssl.config; diff --git a/table-api/src/main/java/io/deephaven/api/TableOperations.java b/table-api/src/main/java/io/deephaven/api/TableOperations.java index d9e0135e66f..6b6b6cfc92f 100644 --- a/table-api/src/main/java/io/deephaven/api/TableOperations.java +++ b/table-api/src/main/java/io/deephaven/api/TableOperations.java @@ -524,7 +524,7 @@ TOPS asOfJoin( *

      A single-value range is a range where the left row’s values for the left start column and left end * column are equal and both relative matches are inclusive ({@code <=} and {@code >=}, respectively). For a * single-value range, only rows within the bucket where the right range column matches the single value are - * included in the output aggregations. + * included in the output aggregations.
      *
      invalid ranges
      *
      An invalid range occurs in two scenarios: First, when the range is inverted, i.e. when the value of * the left start column is greater than the value of the left end column. Second, when either relative-match is @@ -568,9 +568,9 @@ TOPS rangeJoin( * Perform a range join with {@code rightTable}. For each row in {@code this} Table, this operation joins * {@link Aggregation aggregations} over a range of responsive rows from {@code rightTable} according to * zero-or-more exact join matches and one range join match. The operation is performed - * identically to {@link #rangeJoin(TABLE, Collection, RangeJoinMatch, Collection)}, after parsing is applied to the - * elements of {@code columnsToMatch} to produce the {@link JoinMatch exact join matches} and {@link RangeJoinMatch - * range join match}. + * identically to {@link #rangeJoin(Object, Collection, RangeJoinMatch, Collection)}, after parsing is applied to + * the elements of {@code columnsToMatch} to produce the {@link JoinMatch exact join matches} and + * {@link RangeJoinMatch range join match}. *

      *

      {@code columnsToMatch} Parsing

      *

      @@ -605,7 +605,7 @@ TOPS rangeJoin( *

    9. For {@link RangeStartRule#LESS_THAN less than} paired with {@link RangeEndRule#GREATER_THAN greater than}: * *
      -     * "leftStartColumn < rightRangeColumn < leftEndColumn"
      +     * "leftStartColumn < rightRangeColumn < leftEndColumn"
            * 
      * *
    10. @@ -613,7 +613,7 @@ TOPS rangeJoin( * {@link RangeEndRule#GREATER_THAN_OR_EQUAL greater than or equal}: * *
      -     * "leftStartColumn <= rightRangeColumn <= leftEndColumn"
      +     * "leftStartColumn <= rightRangeColumn <= leftEndColumn"
            * 
      * *
    11. @@ -621,7 +621,7 @@ TOPS rangeJoin( * with {@link RangeEndRule#GREATER_THAN_OR_EQUAL_ALLOW_FOLLOWING greater than or equal (allow following)}: * *
      -     * "<- leftStartColumn <= rightRangeColumn <= leftEndColumn ->"
      +     * "<- leftStartColumn <= rightRangeColumn <= leftEndColumn ->"
            * 
      * * diff --git a/table-api/src/main/java/io/deephaven/api/updateby/UpdateByOperation.java b/table-api/src/main/java/io/deephaven/api/updateby/UpdateByOperation.java index 36bd2f294ae..f59e448cbd2 100644 --- a/table-api/src/main/java/io/deephaven/api/updateby/UpdateByOperation.java +++ b/table-api/src/main/java/io/deephaven/api/updateby/UpdateByOperation.java @@ -616,7 +616,7 @@ static UpdateByOperation EmMax(OperationControl control, String timestampColumn, * *
            *     a = e^(-1 / tickDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            * 
      @@ -638,7 +638,7 @@ static UpdateByOperation EmStd(double tickDecay, String... pairs) { * *
            *     a = e^(-1 / tickDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            * 
      @@ -662,7 +662,7 @@ static UpdateByOperation EmStd(final OperationControl control, double tickDecay, * *
            *     a = e^(-dt / timeDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            * 
      @@ -685,7 +685,7 @@ static UpdateByOperation EmStd(String timestampColumn, long timeDecay, String... * *
            *     a = e^(-dt / timeDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            * 
      @@ -710,7 +710,7 @@ static UpdateByOperation EmStd(OperationControl control, String timestampColumn, * *
            *     a = e^(-dt / durationDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            * 
      @@ -733,7 +733,7 @@ static UpdateByOperation EmStd(String timestampColumn, Duration durationDecay, S * *
            *     a = e^(-dt / durationDecay)
      -     *     variance = a * (prevVariance + (1 − a) * (x − prevEma)^2)
      +     *     variance = a * (prevVariance + (1 - a) * (x - prevEma)^2)
            *     ema = a * prevEma + x
            *     std = sqrt(variance)
            *