[GitHub] [bookkeeper] kezhuw opened a new issue #2953: Mismatch between javadoc of `org.apache.bookkeeper.client.api.LedgerEntry.getLength` and its implementation

[GitBox <gi...@apache.org>]

kezhuw opened a new issue #2953:
URL: https://github.com/apache/bookkeeper/issues/2953


   **BUG REPORT**
   
   ***Describe the bug***
   * Javadoc here:
     ```javadoc
       /**
        * The length of the entry, that is the size of the content expressed in bytes.
        *
        * @return the size of the content
        */
       long getLength();
     ```
   * The implementation returns accumulated entry payload(not metadata) length till returned entry(inclusive).
   
   ***To Reproduce***
   Omit.
   
   ***Expected behavior***
   Consistent between javadoc and its implementation.
   
   ***Screenshots***
   
   None.
   
   ***Additional context***
   I checked [commit tree](https://github.com/apache/bookkeeper/tree/95373234a273920fadc06742479ddcc4e603fa1b) where `LedgerEntry` interface has not been added. `getLength` returned accumulated length. If this is intended, I think it deserve a more verbose name.
   


-- 
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@bookkeeper.apache.org

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