View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.types;
19  
20  import org.apache.hadoop.hbase.classification.InterfaceAudience;
21  import org.apache.hadoop.hbase.classification.InterfaceStability;
22  import org.apache.hadoop.hbase.util.Order;
23  import org.apache.hadoop.hbase.util.OrderedBytes;
24  import org.apache.hadoop.hbase.util.PositionedByteRange;
25  
26  /**
27   * A {@code byte[]} of variable-length. Build on
28   * {@link OrderedBytes#encodeBlobCopy(PositionedByteRange, byte[], int, int, Order)}.
29   */
30  @InterfaceAudience.Public
31  @InterfaceStability.Evolving
32  public class OrderedBlob extends OrderedBytesBase<byte[]> {
33  
34    public static final OrderedBlob ASCENDING = new OrderedBlob(Order.ASCENDING);
35    public static final OrderedBlob DESCENDING = new OrderedBlob(Order.DESCENDING);
36  
37    protected OrderedBlob(Order order) { super(order); }
38  
39    @Override
40    public boolean isSkippable() { return false; }
41  
42    @Override
43    public int encodedLength(byte[] val) {
44      return null == val ?
45        (Order.ASCENDING == order ? 1 : 2) :
46        (Order.ASCENDING == order ? val.length + 1 : val.length + 2);
47    }
48  
49    @Override
50    public Class<byte[]> encodedClass() { return byte[].class; }
51  
52    @Override
53    public byte[] decode(PositionedByteRange src) {
54      return OrderedBytes.decodeBlobCopy(src);
55    }
56  
57    @Override
58    public int encode(PositionedByteRange dst, byte[] val) {
59      return OrderedBytes.encodeBlobCopy(dst, val, order);
60    }
61  
62    /**
63     * Write a subset of {@code val} to {@code dst}.
64     */
65    public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen) {
66      return OrderedBytes.encodeBlobCopy(dst, val, voff, vlen, order);
67    }
68  }