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  /**
28   * A {@code byte} of 8-bits using a fixed-length encoding. Built on
29   * {@link OrderedBytes#encodeInt8(PositionedByteRange, byte, Order)}.
30   */
31  @InterfaceAudience.Public
32  @InterfaceStability.Evolving
33  public class OrderedInt8 extends OrderedBytesBase<Byte> {
34  
35    public static final OrderedInt8 ASCENDING = new OrderedInt8(Order.ASCENDING);
36    public static final OrderedInt8 DESCENDING = new OrderedInt8(Order.DESCENDING);
37  
38    protected OrderedInt8(Order order) { super(order); }
39  
40    @Override
41    public boolean isNullable() { return false; }
42  
43    @Override
44    public int encodedLength(Byte val) { return 2; }
45  
46    @Override
47    public Class<Byte> encodedClass() { return Byte.class; }
48  
49    @Override
50    public Byte decode(PositionedByteRange src) {
51      return OrderedBytes.decodeInt8(src);
52    }
53  
54    @Override
55    public int encode(PositionedByteRange dst, Byte val) {
56      if (null == val) throw new IllegalArgumentException("Null values not supported.");
57      return OrderedBytes.encodeInt8(dst, val, order);
58    }
59  
60    /**
61     * Read a {@code byte} value from the buffer {@code src}.
62     */
63    public byte decodeByte(PositionedByteRange src) {
64      return OrderedBytes.decodeInt8(src);
65    }
66  
67    /**
68     * Write instance {@code val} into buffer {@code dst}.
69     */
70    public int encodeByte(PositionedByteRange dst, byte val) {
71      return OrderedBytes.encodeInt8(dst, val, order);
72    }
73  }