update Java version

Author: peteroupc

src/main/java/com/upokecenter/cbor/CBORTypeFilter.java

@@ -67,9 +67,8 @@ public final class CBORTypeFilter {
      * index is allowed under this type filter, otherwise, false.
      */
     public boolean ArrayIndexAllowed(int index) {
-   return (this.types & (1 << 4)) != 0 && index >= 0 && (this.anyArrayLength
-        ||
-           ((this.arrayMinLength || index < this.arrayLength) && index >=
+   return (this.types & (1 << 4)) != 0 && index >= 0 && (this.anyArrayLength||
+        ((this.arrayMinLength || index < this.arrayLength) && index >=
                     0));
     }
 
@@ -117,9 +116,11 @@ public boolean ArrayLengthMatches(EInteger bigLength) {
     }
 
     /**
-     * Not documented yet.
-     * @param index A 32-bit signed integer.
-     * @return A CBORTypeFilter object.
+     * Gets the type filter for this array filter by its index.
+     * @param index A zero-based index of the filter to retrieve.
+     * @return Returns None if the index is out of range, or Any if this filter
+     * doesn't filter an array. Returns the appropriate filter for the array
+     * index otherwise.
      */
     public CBORTypeFilter GetSubFilter(int index) {
       if (this.anyArrayLength || this.any) {
@@ -144,9 +145,11 @@ public CBORTypeFilter GetSubFilter(int index) {
     }
 
     /**
-     * Not documented yet.
-     * @param index A 64-bit signed integer.
-     * @return A CBORTypeFilter object.
+     * Gets the type filter for this array filter by its index.
+     * @param index A zero-based index of the filter to retrieve.
+     * @return Returns None if the index is out of range, or Any if this filter
+     * doesn't filter an array. Returns the appropriate filter for the array
+     * index otherwise.
      */
     public CBORTypeFilter GetSubFilter(long index) {
       if (this.anyArrayLength || this.any) {

src/main/java/com/upokecenter/util/ExtendedDecimal.java

@@ -265,7 +265,7 @@ public static ExtendedDecimal CreateNaN(
     }
 
     /**
-     * Creates a decimal number from a string that represents a number. See
+     * Creates a decimal number from a text string that represents a number. See
      * <code>FromString(String, int, int, EContext)</code> for more information.
      * @param str A string that represents a number.
      * @return An arbitrary-precision decimal number with the same value as the
@@ -279,7 +279,7 @@ public static ExtendedDecimal FromString(String str) {
     }
 
     /**
-     * Creates a decimal number from a string that represents a number. See
+     * Creates a decimal number from a text string that represents a number. See
      * <code>FromString(String, int, int, EContext)</code> for more information.
      * @param str A string that represents a number.
      * @param ctx A precision context to control precision, rounding, and exponent
@@ -306,7 +306,7 @@ public static ExtendedDecimal FromString(String str, PrecisionContext ctx) {
     }
 
     /**
-     * Creates a decimal number from a string that represents a number. See
+     * Creates a decimal number from a text string that represents a number. See
      * <code>FromString(String, int, int, EContext)</code> for more information.
      * @param str A string that represents a number.
      * @param offset A zero-based index showing where the desired portion of {@code
@@ -329,7 +329,7 @@ public static ExtendedDecimal FromString(
     }
 
     /**
-     * <p>Creates a decimal number from a string that represents a number.</p>
+     * <p>Creates a decimal number from a text string that represents a number.</p>
      * <p>The format of the string generally consists of:</p> <ul> <li>An
      * optional plus sign ("+" , U+002B) or minus sign ("-", U+002D) (if '-'
      * , the value is negative.)</li> <li>One or more digits, with a single

src/main/java/com/upokecenter/util/ExtendedRational.java

@@ -12,13 +12,16 @@
     /**
      * <p><b>This class is largely obsolete. It will be replaced by a new version
      * of this class in a different namespace/package and library, called
-     * <code>PeterO.Numbers.ERational</code> in the <code>PeterO.Numbers</code> library
-     * (in .NET), or <code>com.upokecenter.numbers.getERational()</code> in the
-     * <code>com.github.peteroupc/numbers</code> artifact (in Java). This new
-     * class can be used in the <code>CBORObject.FromObject(Object)</code> method
-     * (by including the new library in your code, among other things), but
-     * this version of the CBOR library doesn't include any methods that
-     * explicitly take an <code>ERational</code> as a parameter or return
+     * <code>PeterO.Numbers.ERational</code> in the <a
+  * href='https://www.nuget.org/packages/PeterO.Numbers'><code>PeterO.Numbers</code></a>
+     * library (in .NET), or <code>com.upokecenter.numbers.ERational</code> in the
+     * <a
+  * href='https://github.com/peteroupc/numbers-java'><code>com.github.peteroupc/numbers</code></a>
+     * artifact (in Java). This new class can be used in the
+     * <code>CBORObject.FromObject(Object)</code> method (by including the new
+     * library in your code, among other things), but this version of the
+     * CBOR library doesn't include any methods that explicitly take an
+     * <code>ERational</code> as a parameter or return
      * value.</b></p>Arbitrary-precision rational number. This class cannot
      * be inherited; this is a change in version 2.0 from previous versions,
      * where the class was inadvertently left inheritable. <p><b>Thread
@@ -112,7 +115,7 @@ public final BigInteger getDenominator() {
 
     /**
      * Gets a value indicating whether this object is finite (not infinity or NaN).
-     * @return True if this object is finite (not infinity or NaN); otherwise,
+     * @return true if this object is finite (not infinity or NaN); otherwise,
      * false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
@@ -124,15 +127,15 @@ public final boolean isFinite() {
     /**
      * Gets a value indicating whether this object's value is negative (including
      * negative zero).
-     * @return True if this object's value is negative; otherwise, false.
+     * @return true if this object's value is negative, otherwise, false.
      */
     public final boolean isNegative() {
         return this.getEr().isNegative();
       }
 
     /**
      * Gets a value indicating whether this object's value equals 0.
-     * @return True if this object's value equals 0; otherwise, false.
+     * @return true if this object's value equals 0, otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
 @Deprecated
@@ -290,7 +293,7 @@ public static ExtendedRational FromExtendedDecimal(ExtendedDecimal ef) {
     }
 
     /**
-     * Not documented yet.
+     * Converts an arbitrary-precision binary float to a rational number.
      * @param ef An arbitrary-precision binary float.
      * @return An arbitrary-precision rational number.
      * @throws java.lang.NullPointerException The parameter {@code ef} is null.
@@ -305,7 +308,7 @@ public static ExtendedRational FromExtendedFloat(ExtendedFloat ef) {
     }
 
     /**
-     * Not documented yet.
+     * Converts a 32-bit signed integer to a rational number.
      * @param smallint A 32-bit signed integer.
      * @return An arbitrary-precision rational number.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
@@ -316,7 +319,7 @@ public static ExtendedRational FromInt32(int smallint) {
     }
 
     /**
-     * Not documented yet.
+     * Converts a 64-bit signed integer to a rational number.
      * @param longInt A 64-bit signed integer.
      * @return An arbitrary-precision rational number.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
@@ -435,17 +438,19 @@ public ExtendedRational Divide(ExtendedRational otherValue) {
     /**
      * Determines whether this object and another object are equal.
      * @param obj An arbitrary object.
-     * @return True if the objects are equal; otherwise, false.
+     * @return true if the objects are equal; otherwise, false.
      */
     @Override public boolean equals(Object obj) {
       ExtendedRational bi = ((obj instanceof ExtendedRational) ? (ExtendedRational)obj : null);
       return (bi == null) ? false : this.getEr().equals(bi.getEr());
     }
 
     /**
-     * Not documented yet.
-     * @param other An arbitrary-precision rational number.
-     * @return A Boolean object.
+     * Returns whether this object's properties are equal to the properties of
+     * another rational number object.
+     * @param other Another arbitrary-precision rational number.
+     * @return true if this object's properties are equal to the properties of
+     * another rational number object; otherwise, false.
      * @throws java.lang.NullPointerException The parameter {@code other} is null.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
@@ -467,7 +472,7 @@ public boolean equals(ExtendedRational other) {
 
     /**
      * Gets a value indicating whether this object's value is infinity.
-     * @return True if this object's value is infinity; otherwise, false.
+     * @return true if this object's value is infinity, otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
 @Deprecated
@@ -477,15 +482,15 @@ public boolean IsInfinity() {
 
     /**
      * Returns whether this object is a not-a-number value.
-     * @return True if this object is a not-a-number value; otherwise, false.
+     * @return true if this object is a not-a-number value, otherwise, false.
      */
     public boolean IsNaN() {
       return this.getEr().IsNaN();
     }
 
     /**
      * Returns whether this object is negative infinity.
-     * @return True if this object is negative infinity; otherwise, false.
+     * @return true if this object is negative infinity, otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
 @Deprecated
@@ -495,7 +500,7 @@ public boolean IsNegativeInfinity() {
 
     /**
      * Returns whether this object is positive infinity.
-     * @return True if this object is positive infinity; otherwise, false.
+     * @return true if this object is positive infinity, otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
 @Deprecated
@@ -505,7 +510,7 @@ public boolean IsPositiveInfinity() {
 
     /**
      * Returns whether this object is a quiet not-a-number value.
-     * @return True if this object is a quiet not-a-number value; otherwise, false.
+     * @return true if this object is a quiet not-a-number value; otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.
  */
 @Deprecated
@@ -517,7 +522,7 @@ public boolean IsQuietNaN() {
      * Returns whether this object is a signaling not-a-number value (which causes
      * an error if the value is passed to any arithmetic operation in this
      * class).
-     * @return True if this object is a signaling not-a-number value (which causes
+     * @return true if this object is a signaling not-a-number value (which causes
      * an error if the value is passed to any arithmetic operation in this
      * class); otherwise, false.
      * @deprecated Use ERational from PeterO.Numbers/com.upokecenter.numbers.