You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@commons.apache.org by "elharo (via GitHub)" <gi...@apache.org> on 2024/01/25 12:38:16 UTC

[PR] Clarify and correct API doc [commons-io]

elharo opened a new pull request, #566:
URL: https://github.com/apache/commons-io/pull/566

   Most of the methods in this class are badly named. Except for the swap method they all just read and write in little endian order. E.g. consider readSwappedInteger
   
   ```
       public static int readSwappedInteger(final InputStream input) throws IOException {
           final int value1 = read(input);
           final int value2 = read(input);
           final int value3 = read(input);
           final int value4 = read(input);
           return ((value1 & 0xff) << 0) + ((value2 & 0xff) << 8) + ((value3 & 0xff) << 16) + ((value4 & 0xff) << 24);
       }
   ```
   
   This always reads four bytes from an input stream and always considers the first byte read to be the least significant. It would have been better named readLittleEndianInteger.
   
   I'm tempted to deprecate the whole thing and replace it with something better named, but for now at least let's correct the Java doc. 
   
   @garydgregory 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Clarify and correct EndianUtils API doc [commons-io]

Posted by "elharo (via GitHub)" <gi...@apache.org>.

elharo commented on PR #566:
URL: https://github.com/apache/commons-io/pull/566#issuecomment-1911254305

   PTAL


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Clarify and correct EndianUtils and SwappedDataInputStream API doc [commons-io]

Posted by "elharo (via GitHub)" <gi...@apache.org>.

elharo commented on code in PR #566:
URL: https://github.com/apache/commons-io/pull/566#discussion_r1467733794


##########
src/main/java/org/apache/commons/io/EndianUtils.java:
##########
@@ -182,13 +194,14 @@ public static short readSwappedShort(final InputStream input) throws IOException
     }
 
     /**
-     * Reads an unsigned integer (32-bit) value from a byte array at a given
-     * offset. The value is converted to the opposed endian system while
-     * reading.
+     * Reads a little endian unsigned integer (32-bit) value from a byte array at a given

Review Comment:
   Since Java's ints are signed you can't fit the unsigned int values from ~2.2 billion  to ~4 billion into an int, so you have to return a long. The long will always be <= 2^32, but might be greater than Integer.MAX_INT. Not sure how much of that to say here.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org