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 byte[]} of variable-length. Build on 027 * {@link OrderedBytes#encodeBlobCopy(PositionedByteRange, byte[], int, int, Order)}. 028 */ 029@InterfaceAudience.Public 030public class OrderedBlob extends OrderedBytesBase<byte[]> { 031 032 public static final OrderedBlob ASCENDING = new OrderedBlob(Order.ASCENDING); 033 public static final OrderedBlob DESCENDING = new OrderedBlob(Order.DESCENDING); 034 035 protected OrderedBlob(Order order) { 036 super(order); 037 } 038 039 @Override 040 public boolean isSkippable() { 041 return false; 042 } 043 044 @Override 045 public int encodedLength(byte[] val) { 046 return null == val ? 047 (Order.ASCENDING == order ? 1 : 2) : 048 (Order.ASCENDING == order ? val.length + 1 : val.length + 2); 049 } 050 051 @Override 052 public Class<byte[]> encodedClass() { 053 return byte[].class; 054 } 055 056 @Override 057 public byte[] decode(PositionedByteRange src) { 058 return OrderedBytes.decodeBlobCopy(src); 059 } 060 061 @Override 062 public int encode(PositionedByteRange dst, byte[] val) { 063 return OrderedBytes.encodeBlobCopy(dst, val, order); 064 } 065 066 /** 067 * Write a subset of {@code val} to {@code dst}. 068 */ 069 public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen) { 070 return OrderedBytes.encodeBlobCopy(dst, val, voff, vlen, order); 071 } 072}