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 String} of variable-length. Built on
28   * {@link OrderedBytes#encodeString(PositionedByteRange, String, Order)}.
29   */
30  @InterfaceAudience.Public
31  @InterfaceStability.Evolving
32  public class OrderedString extends OrderedBytesBase<String> {
33  
34    public static final OrderedString ASCENDING = new OrderedString(Order.ASCENDING);
35    public static final OrderedString DESCENDING = new OrderedString(Order.DESCENDING);
36  
37    protected OrderedString(Order order) { super(order); }
38  
39    @Override
40    public int encodedLength(String val) {
41      // TODO: use of UTF8 here is a leaky abstraction.
42      return null == val ? 1 : val.getBytes(OrderedBytes.UTF8).length + 2;
43    }
44  
45    @Override
46    public Class<String> encodedClass() { return String.class; }
47  
48    @Override
49    public String decode(PositionedByteRange src) {
50      return OrderedBytes.decodeString(src);
51    }
52  
53    @Override
54    public int encode(PositionedByteRange dst, String val) {
55      return OrderedBytes.encodeString(dst, val, order);
56    }
57  }