Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-26404

Update javadoc for CellUtil#createCell with tags methods.

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 2.4.8
    • 2.5.0, 2.4.9
    • None
    • None
    • Reviewed

    Description

      We have the following methods in CellUtil class which are deprecated. We used to use this method within custom COPROC to create cells with custom tags. We deprecated them in 2.0.0 version and created a new class called RawCell which is LimitedPrivate with visibility set to COPROC. There is no reference to RawCell#createCell(Cell cell, List<Tag> tags) method in javadoc of CellUtil#createCell methods which are now deprecated. This is not user friendly. We should improve the javadoc within CellUtil#createCell(Cell, tags) method.

        /**
         * Note : Now only CPs can create cell with tags using the CP environment
         * @return A new cell which is having the extra tags also added to it.
         * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0.
         *
         */
        @Deprecated
        public static Cell createCell(Cell cell, List<Tag> tags) {
          return PrivateCellUtil.createCell(cell, tags);
        }
      
        public static Cell createCell(Cell cell, byte[] tags) 
        public static Cell createCell(Cell cell, byte[] value, byte[] tags) {
      

      This improvement is only applicable to branch-2 since we have removed these methods in branch-3.

      Attachments

        Issue Links

          Activity

            People

              shahrs87 Rushabh Shah
              shahrs87 Rushabh Shah
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: