[jira] Commented: (HBASE-3634) Fix JavaDoc for put(List puts) in HTabkeInterface

["Lars George (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/HBASE-3634?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13006410#comment-13006410 ] 

Lars George commented on HBASE-3634:
------------------------------------

Alternatively we can call processBatchOfPuts() etc. instead that modify the list as advertised.

> Fix JavaDoc for put(List<Put> puts) in HTabkeInterface
> ------------------------------------------------------
>
>                 Key: HBASE-3634
>                 URL: https://issues.apache.org/jira/browse/HBASE-3634
>             Project: HBase
>          Issue Type: Improvement
>          Components: client
>    Affects Versions: 0.90.1
>            Reporter: Lars George
>            Priority: Trivial
>             Fix For: 0.92.0
>
>
> We say this in the interface:
> {code}
>   /**
>    * Puts some data in the table, in batch.
>    * <p>
>    * If {@link #isAutoFlush isAutoFlush} is false, the update is buffered
>    * until the internal buffer is full.
>    * @param puts The list of mutations to apply.  The list gets modified by this
>    * method (in particular it gets re-ordered, so the order in which the elements
>    * are inserted in the list gives no guarantee as to the order in which the
>    * {@link Put}s are executed).
>    * @throws IOException if a remote or network exception occurs. In that case
>    * the {@code puts} argument will contain the {@link Put} instances that
>    * have not be successfully applied.
>    * @since 0.20.0
>    */
>   void put(List<Put> puts) throws IOException;
> {code}
> This is outdated and needs to be updated to reflect that this is nothing else but a client side iteration over all puts, but using the write buffer to aggregate to one RPC. The list is never modified and after the call contains the same number of elements.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira