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 * An alternative to {@link OrderedBlob} for use by {@link Struct} fields that do not terminate the 027 * fields list. Built on 028 * {@link OrderedBytes#encodeBlobVar(PositionedByteRange, byte[], int, int, Order)}. 029 */ 030@InterfaceAudience.Public 031public class OrderedBlobVar extends OrderedBytesBase<byte[]> { 032 033 public static final OrderedBlobVar ASCENDING = new OrderedBlobVar(Order.ASCENDING); 034 public static final OrderedBlobVar DESCENDING = new OrderedBlobVar(Order.DESCENDING); 035 036 protected OrderedBlobVar(Order order) { 037 super(order); 038 } 039 040 @Override 041 public int encodedLength(byte[] val) { 042 return null == val ? 1 : OrderedBytes.blobVarEncodedLength(val.length); 043 } 044 045 @Override 046 public Class<byte[]> encodedClass() { 047 return byte[].class; 048 } 049 050 @Override 051 public byte[] decode(PositionedByteRange src) { 052 return OrderedBytes.decodeBlobVar(src); 053 } 054 055 @Override 056 public int encode(PositionedByteRange dst, byte[] val) { 057 return OrderedBytes.encodeBlobVar(dst, val, order); 058 } 059 060 /** 061 * Write a subset of {@code val} to {@code buff}. 062 */ 063 public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen) { 064 return OrderedBytes.encodeBlobVar(dst, val, voff, vlen, order); 065 } 066}