update Java version

Author: peteroupc

api/com.upokecenter.cbor.CBORDateConverter.md

@@ -18,20 +18,20 @@
  Conversion type for date-time conversion.
 * `static CBORDateConverter TaggedNumber`<br>
  A converter object where FromCBORObject accepts CBOR objects with tag 0
- (date/time strings) and tag 1 (number of seconds since the start
- of 1970), and ToCBORObject converts date/time objects (java.util.Date
- in DotNet, and Date in Java) to CBOR objects of tag 1.
+ (date/time strings) and tag 1 (number of seconds since the start of
+ 1970), and ToCBORObject converts date/time objects (java.util.Date in
+ DotNet, and Date in Java) to CBOR objects of tag 1.
 * `static CBORDateConverter TaggedString`<br>
  A converter object where FromCBORObject accepts CBOR objects with tag 0
- (date/time strings) and tag 1 (number of seconds since the start
- of 1970), and ToCBORObject converts date/time objects (java.util.Date
- in DotNet, and Date in Java) to CBOR objects of tag 0.
+ (date/time strings) and tag 1 (number of seconds since the start of
+ 1970), and ToCBORObject converts date/time objects (java.util.Date in
+ DotNet, and Date in Java) to CBOR objects of tag 0.
 * `static CBORDateConverter UntaggedNumber`<br>
  A converter object where FromCBORObject accepts untagged CBOR integer or
  CBOR floating-point objects that give the number of seconds since
- the start of 1970, and where ToCBORObject converts date/time
- objects (java.util.Date in DotNet, and Date in Java) to such untagged
- CBOR objects.
+ the start of 1970, and where ToCBORObject converts date/time objects
+ (java.util.Date in DotNet, and Date in Java) to such untagged CBOR
+ objects.
 
 ## Nested Classes
 
@@ -50,21 +50,26 @@
 * `CBORObject DateTimeFieldsToCBORObject​(int smallYear,
                           int month,
                           int day)`<br>
- Not documented yet.
+ Converts a date/time in the form of a year, month, and day to a CBOR object.
 * `CBORObject DateTimeFieldsToCBORObject​(int smallYear,
                           int month,
                           int day,
                           int hour,
                           int minute,
                           int second)`<br>
- Not documented yet.
+ Converts a date/time in the form of a year, month, day, hour, minute, and
+ second to a CBOR object.
 * `CBORObject DateTimeFieldsToCBORObject​(com.upokecenter.numbers.EInteger bigYear,
                           int[] lesserFields)`<br>
- Not documented yet.
+ Converts a date/time in the form of a year, month, day, hour, minute,
+ second, fractional seconds, and time offset to a CBOR object.
 * `java.util.Date FromCBORObject​(CBORObject obj)`<br>
- Not documented yet.
+ Converts a CBOR object to a java.util.Date (in DotNet) or a Date (in Java).
+* `CBORDateConverter.ConversionType getType()`<br>
+ Gets the conversion type for this date converter.
 * `CBORObject ToCBORObject​(java.util.Date obj)`<br>
- Not documented yet.
+ Converts a java.util.Date (in DotNet) or Date (in Java) to a CBOR object in a
+ manner specified by this converter's conversion type.
 * `boolean TryGetDateTimeFields​(CBORObject obj,
                     com.upokecenter.numbers.EInteger[] year,
                     int[] lesserFields)`<br>
@@ -75,83 +80,97 @@
 ### TaggedString
     public static final CBORDateConverter TaggedString
 A converter object where FromCBORObject accepts CBOR objects with tag 0
- (date/time strings) and tag 1 (number of seconds since the start
- of 1970), and ToCBORObject converts date/time objects (java.util.Date
- in DotNet, and Date in Java) to CBOR objects of tag 0.
+ (date/time strings) and tag 1 (number of seconds since the start of
+ 1970), and ToCBORObject converts date/time objects (java.util.Date in
+ DotNet, and Date in Java) to CBOR objects of tag 0.
 ### TaggedNumber
     public static final CBORDateConverter TaggedNumber
 A converter object where FromCBORObject accepts CBOR objects with tag 0
- (date/time strings) and tag 1 (number of seconds since the start
- of 1970), and ToCBORObject converts date/time objects (java.util.Date
- in DotNet, and Date in Java) to CBOR objects of tag 1. The
- ToCBORObject conversion is lossless only if the number of seconds
- since the start of 1970 can be represented exactly as an integer
- in the interval [-(2^64), 2^64 - 1] or as a 64-bit floating-point
- number in the IEEE 754r binary64 format; the conversion is lossy
- otherwise. The ToCBORObject conversion will throw an exception if
- the conversion to binary64 results in positive infinity, negative
- infinity, or not-a-number.
+ (date/time strings) and tag 1 (number of seconds since the start of
+ 1970), and ToCBORObject converts date/time objects (java.util.Date in
+ DotNet, and Date in Java) to CBOR objects of tag 1. The ToCBORObject
+ conversion is lossless only if the number of seconds since the start
+ of 1970 can be represented exactly as an integer in the interval
+ [-(2^64), 2^64 - 1] or as a 64-bit floating-point number in the IEEE
+ 754r binary64 format; the conversion is lossy otherwise. The
+ ToCBORObject conversion will throw an exception if the conversion to
+ binary64 results in positive infinity, negative infinity, or
+ not-a-number.
 ### UntaggedNumber
     public static final CBORDateConverter UntaggedNumber
 A converter object where FromCBORObject accepts untagged CBOR integer or
  CBOR floating-point objects that give the number of seconds since
- the start of 1970, and where ToCBORObject converts date/time
- objects (java.util.Date in DotNet, and Date in Java) to such untagged
- CBOR objects. The ToCBORObject conversion is lossless only if the
- number of seconds since the start of 1970 can be represented
- exactly as an integer in the interval [-(2^64), 2^64 - 1] or as a
- 64-bit floating-point number in the IEEE 754r binary64 format;
- the conversion is lossy otherwise. The ToCBORObject conversion
- will throw an exception if the conversion to binary64 results in
- positive infinity, negative infinity, or not-a-number.
+ the start of 1970, and where ToCBORObject converts date/time objects
+ (java.util.Date in DotNet, and Date in Java) to such untagged CBOR
+ objects. The ToCBORObject conversion is lossless only if the number
+ of seconds since the start of 1970 can be represented exactly as an
+ integer in the interval [-(2^64), 2^64 - 1] or as a 64-bit
+ floating-point number in the IEEE 754r binary64 format; the
+ conversion is lossy otherwise. The ToCBORObject conversion will
+ throw an exception if the conversion to binary64 results in positive
+ infinity, negative infinity, or not-a-number.
 ## Method Details
 
+### getType
+    public final CBORDateConverter.ConversionType getType()
+Gets the conversion type for this date converter.
+
+**Returns:**
+
+* The conversion type for this date converter.
+
 ### FromCBORObject
     public java.util.Date FromCBORObject​(CBORObject obj)
-Not documented yet.
+Converts a CBOR object to a java.util.Date (in DotNet) or a Date (in Java).
 
 **Specified by:**
 
 * <code>FromCBORObject</code> in interface <code>ICBORToFromConverter&lt;java.util.Date&gt;</code>
 
 **Parameters:**
 
-* <code>obj</code> - The parameter <code>obj</code> is a Cbor.CBORObject object.
+* <code>obj</code> - A CBOR object that specifies a date/time according to the
+ conversion type used to create this date converter.
 
 **Returns:**
 
-* The return value is not documented yet.
+* A java.util.Date or Date that encodes the date/time specified in the CBOR
+ object.
 
 **Throws:**
 
 * <code>java.lang.NullPointerException</code> - The parameter <code>obj</code> is null.
 
+* <code>CBORException</code> - The format of the CBOR object is
+ not supported, or another error occurred in conversion.
+
 ### TryGetDateTimeFields
     public boolean TryGetDateTimeFields​(CBORObject obj, com.upokecenter.numbers.EInteger[] year, int[] lesserFields)
 Tries to extract the fields of a date and time in the form of a CBOR object.
 
 **Parameters:**
 
-* <code>obj</code> - The parameter <code>obj</code> is a Cbor.CBORObject object.
+* <code>obj</code> - A CBOR object that specifies a date/time according to the
+ conversion type used to create this date converter.
 
 * <code>year</code> - An array whose first element will store the year. The array's
- length must be 1 or greater. If this function fails, the first element
- is set to null.
+ length must be 1 or greater. If this function fails, the first
+ element is set to null.
 
 * <code>lesserFields</code> - An array that will store the fields (other than the
  year) of the date and time. The array's length must be 7 or greater.
- If this function fails, the first seven elements are set to 0. If this
- method is successful, the first seven elements of the array (starting
- at 0) will be as follows: <ul> <li>0 - Month of the year, from 1
- (January) through 12 (December).</li> <li>1 - Day of the month, from 1
- through 31.</li> <li>2 - Hour of the day, from 0 through 23.</li>
- <li>3 - Minute of the hour, from 0 through 59.</li> <li>4 - Second of
- the minute, from 0 through 59.</li> <li>5 - Fractional seconds,
- expressed in nanoseconds. This value cannot be less than 0.</li> <li>6
- - Number of minutes to subtract from this date and time to get global
- time. This number can be positive or negative, but cannot be less than
- -1439 or greater than 1439. For tags 0 and 1, this value is always
- 0.</li></ul>.
+ If this function fails, the first seven elements are set to 0. If
+ this method is successful, the first seven elements of the array
+ (starting at 0) will be as follows: <ul> <li>0 - Month of the year,
+ from 1 (January) through 12 (December).</li> <li>1 - Day of the
+ month, from 1 through 31.</li> <li>2 - Hour of the day, from 0
+ through 23.</li> <li>3 - Minute of the hour, from 0 through 59.</li>
+ <li>4 - Second of the minute, from 0 through 59.</li> <li>5 -
+ Fractional seconds, expressed in nanoseconds. This value cannot be
+ less than 0.</li> <li>6 - Number of minutes to subtract from this
+ date and time to get global time. This number can be positive or
+ negative, but cannot be less than -1439 or greater than 1439. For
+ tags 0 and 1, this value is always 0.</li></ul>.
 
 **Returns:**
 
@@ -165,7 +184,9 @@ Tries to extract the fields of a date and time in the form of a CBOR object.
 
 ### DateTimeFieldsToCBORObject
     public CBORObject DateTimeFieldsToCBORObject​(int smallYear, int month, int day)
-Not documented yet.
+Converts a date/time in the form of a year, month, and day to a CBOR object.
+ The hour, minute, and second are treated as 00:00:00 by this method,
+ and the time offset is treated as 0 by this method.
 
 **Parameters:**
 
@@ -180,9 +201,15 @@ Not documented yet.
 * A CBOR object encoding the given date fields according to the
  conversion type used to create this date converter.
 
+**Throws:**
+
+* <code>CBORException</code> - An error occurred in conversion.
+
 ### DateTimeFieldsToCBORObject
     public CBORObject DateTimeFieldsToCBORObject​(int smallYear, int month, int day, int hour, int minute, int second)
-Not documented yet.
+Converts a date/time in the form of a year, month, day, hour, minute, and
+ second to a CBOR object. The time offset is treated as 0 by this
+ method.
 
 **Parameters:**
 
@@ -203,9 +230,14 @@ Not documented yet.
 * A CBOR object encoding the given date fields according to the
  conversion type used to create this date converter.
 
+**Throws:**
+
+* <code>CBORException</code> - An error occurred in conversion.
+
 ### DateTimeFieldsToCBORObject
     public CBORObject DateTimeFieldsToCBORObject​(com.upokecenter.numbers.EInteger bigYear, int[] lesserFields)
-Not documented yet.
+Converts a date/time in the form of a year, month, day, hour, minute,
+ second, fractional seconds, and time offset to a CBOR object.
 
 **Parameters:**
 
@@ -225,9 +257,12 @@ Not documented yet.
 * <code>java.lang.NullPointerException</code> - The parameter <code>bigYear</code> or <code>
  lesserFields</code> is null.
 
+* <code>CBORException</code> - An error occurred in conversion.
+
 ### ToCBORObject
     public CBORObject ToCBORObject​(java.util.Date obj)
-Not documented yet.
+Converts a java.util.Date (in DotNet) or Date (in Java) to a CBOR object in a
+ manner specified by this converter's conversion type.
 
 **Specified by:**
 
@@ -239,4 +274,9 @@ Not documented yet.
 
 **Returns:**
 
-* The return value is not documented yet.
+* A CBOR object encoding the date/time in the java.util.Date or Date
+ according to the conversion type used to create this date converter.
+
+**Throws:**
+
+* <code>CBORException</code> - An error occurred in conversion.

api/com.upokecenter.cbor.CBOREncodeOptions.md

@@ -15,14 +15,19 @@ Specifies options for encoding and decoding CBOR objects.
 ## Constructors
 
 * `CBOREncodeOptions() CBOREncodeOptions`<br>
- Initializes a new instance of the CBOREncodeOptions class.
+ Initializes a new instance of the CBOREncodeOptions class with all the default
+ options.
 * `CBOREncodeOptions​(boolean useIndefLengthStrings,
-                 boolean allowDuplicateKeys) CBOREncodeOptions`<br>
- Initializes a new instance of the CBOREncodeOptions class.
+                 boolean allowDuplicateKeys)`<br>
+ Deprecated.
+Use the more readable String constructor instead.
+ Use the more readable String constructor instead.
 * `CBOREncodeOptions​(boolean useIndefLengthStrings,
                  boolean allowDuplicateKeys,
-                 boolean ctap2Canonical) CBOREncodeOptions`<br>
- Initializes a new instance of the CBOREncodeOptions class.
+                 boolean ctap2Canonical)`<br>
+ Deprecated.
+Use the more readable String constructor instead.
+ Use the more readable String constructor instead.
 * `CBOREncodeOptions​(java.lang.String paramString) CBOREncodeOptions`<br>
  Initializes a new instance of the CBOREncodeOptions class.
 
@@ -46,6 +51,10 @@ Specifies options for encoding and decoding CBOR objects.
  allowed when decoding, and floating-point numbers are written out in
  their 64-bit encoding form regardless of whether their value can be
  encoded without loss in a smaller form.
+* `boolean getFloat64()`<br>
+ Gets a value indicating whether to encode floating-point numbers in a CBOR
+ object in their 64-bit encoding form regardless of whether their
+ value can be encoded without loss in a smaller form.
 * `boolean getResolveReferences()`<br>
  Gets a value indicating whether to resolve references to sharable objects
  and sharable strings in the process of decoding a CBOR object.
@@ -178,6 +187,20 @@ Gets a value indicating whether to allow duplicate keys when reading CBOR
 * A value indicating whether to allow duplicate keys when reading CBOR
  objects from a data stream. The default is false.
 
+### getFloat64
+    public final boolean getFloat64()
+Gets a value indicating whether to encode floating-point numbers in a CBOR
+ object in their 64-bit encoding form regardless of whether their
+ value can be encoded without loss in a smaller form. Used only when
+ encoding CBOR objects.
+
+**Returns:**
+
+* Gets a value indicating whether to encode floating-point numbers in
+ a CBOR object in their 64-bit encoding form regardless of whether
+ their value can be encoded without loss in a smaller form. Used only
+ when encoding CBOR objects. The default is false.
+
 ### getCtap2Canonical
     public final boolean getCtap2Canonical()
 Gets a value indicating whether CBOR objects: <ul> <li>When encoding, are

api/com.upokecenter.cbor.JSONOptions.ConversionMode.md

@@ -81,7 +81,7 @@ JSON numbers are decoded to CBOR as their closest-rounded approximation as
  numbers extremely close to zero may underflow to positive or
  negative zero, and numbers of extremely large absolute value may
  overflow to infinity.). It's important to note that this mode
- affects only how JSON numbers are <code>decoded</code> to a CBOR
+ affects only how JSON numbers are <i>decoded</i> to a CBOR
  object; it doesn't affect how <code>EncodeToBytes</code> and other
  methods encode CBOR objects. Notably, by default,
  <code>EncodeToBytes</code> encodes CBOR floating-point values to the
@@ -101,7 +101,7 @@ A JSON number is decoded to CBOR objects either as a CBOR integer (major
  extremely close to zero may underflow to positive or negative
  zero, and numbers of extremely large absolute value may overflow
  to infinity.). It's important to note that this mode affects only
- how JSON numbers are <code>decoded</code> to a CBOR object; it doesn't
+ how JSON numbers are <i>decoded</i> to a CBOR object; it doesn't
  affect how <code>EncodeToBytes</code> and other methods encode CBOR
  objects. Notably, by default, <code>EncodeToBytes</code> encodes CBOR
  floating-point values to the CBOR format in their 16-bit
@@ -121,7 +121,7 @@ A JSON number is decoded to CBOR objects either as a CBOR integer (major
  (In some cases, numbers extremely close to zero may underflow to
  zero, and numbers of extremely large absolute value may overflow
  to infinity.). It's important to note that this mode affects only
- how JSON numbers are <code>decoded</code> to a CBOR object; it doesn't
+ how JSON numbers are <i>decoded</i> to a CBOR object; it doesn't
  affect how <code>EncodeToBytes</code> and other methods encode CBOR
  objects. Notably, by default, <code>EncodeToBytes</code> encodes CBOR
  floating-point values to the CBOR format in their 16-bit

api/com.upokecenter.cbor.JSONOptions.md

@@ -25,8 +25,8 @@ Includes options to control how CBOR objects are converted to JSON.
  class with default options.
 * `JSONOptions​(boolean base64Padding)`<br>
  Deprecated.
-Use the String constructor instead.
- Use the String constructor instead.
+Use the more readable String constructor instead.
+ Use the more readable String constructor instead.
 * `JSONOptions​(boolean base64Padding,
            boolean replaceSurrogates)`<br>
  Deprecated.

api/com.upokecenter.cbor.PODOptions.md

@@ -15,11 +15,12 @@ Options for controlling how certain DotNET or Java objects, such as
 
 * `PODOptions() PODOptions`<br>
  Initializes a new instance of the PODOptions
- class.
+ class with all the default options.
 * `PODOptions​(boolean removeIsPrefix,
-          boolean useCamelCase) PODOptions`<br>
- Initializes a new instance of the PODOptions
- class.
+          boolean useCamelCase)`<br>
+ Deprecated.
+Use the more readable String constructor instead.
+ Use the more readable String constructor instead.
 * `PODOptions​(java.lang.String paramString) PODOptions`<br>
  Initializes a new instance of the PODOptions
  class.