001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.types;
019
020import org.apache.hadoop.hbase.util.Order;
021import org.apache.hadoop.hbase.util.OrderedBytes;
022import org.apache.hadoop.hbase.util.PositionedByteRange;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * A {@code String} of variable-length. Built on
027 * {@link OrderedBytes#encodeString(PositionedByteRange, String, Order)}.
028 */
029@InterfaceAudience.Public
030public class OrderedString extends OrderedBytesBase<String> {
031
032  public static final OrderedString ASCENDING = new OrderedString(Order.ASCENDING);
033  public static final OrderedString DESCENDING = new OrderedString(Order.DESCENDING);
034
035  protected OrderedString(Order order) {
036    super(order);
037  }
038
039  @Override
040  public int encodedLength(String val) {
041    // TODO: use of UTF8 here is a leaky abstraction.
042    return null == val ? 1 : val.getBytes(OrderedBytes.UTF8).length + 2;
043  }
044
045  @Override
046  public Class<String> encodedClass() {
047    return String.class;
048  }
049
050  @Override
051  public String decode(PositionedByteRange src) {
052    return OrderedBytes.decodeString(src);
053  }
054
055  @Override
056  public int encode(PositionedByteRange dst, String val) {
057    return OrderedBytes.encodeString(dst, val, order);
058  }
059}