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 * @deprecated since 3.0.0 and will be removed in 4.0.0 033 */ 034 @Deprecated 035 public static final OrderedString ASCENDING = new OrderedString(Order.ASCENDING); 036 /** 037 * @deprecated since 3.0.0 and will be removed in 4.0.0 038 */ 039 @Deprecated 040 public static final OrderedString DESCENDING = new OrderedString(Order.DESCENDING); 041 042 /** 043 * Creates a new variable-length {@link String}. 044 * @param order the {@link Order} to use 045 */ 046 public OrderedString(Order order) { 047 super(order); 048 } 049 050 @Override 051 public int encodedLength(String val) { 052 // TODO: use of UTF8 here is a leaky abstraction. 053 return null == val ? 1 : val.getBytes(OrderedBytes.UTF8).length + 2; 054 } 055 056 @Override 057 public Class<String> encodedClass() { 058 return String.class; 059 } 060 061 @Override 062 public String decode(PositionedByteRange src) { 063 return OrderedBytes.decodeString(src); 064 } 065 066 @Override 067 public int encode(PositionedByteRange dst, String val) { 068 return OrderedBytes.encodeString(dst, val, order); 069 } 070}