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.PositionedByteRange; 022import org.apache.yetus.audience.InterfaceAudience; 023 024/** 025 * An {@code DataType} that encodes variable-length values encoded using 026 * {@link org.apache.hadoop.hbase.util.Bytes#putBytes(byte[], int, byte[], int, int)}. 027 * Includes a termination marker following the raw {@code byte[]} value. Intended to make it easier 028 * to transition away from direct use of {@link org.apache.hadoop.hbase.util.Bytes}. 029 * @see org.apache.hadoop.hbase.util.Bytes#putBytes(byte[], int, byte[], int, int) 030 * @see RawBytes 031 * @see OrderedBlob 032 */ 033@InterfaceAudience.Public 034public class RawBytesTerminated extends TerminatedWrapper<byte[]> { 035 036 /** 037 * Create a {@code RawBytesTerminated} using the specified terminator and 038 * {@code order}. 039 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 040 */ 041 public RawBytesTerminated(Order order, byte[] term) { 042 super(new RawBytes(order), term); 043 } 044 045 /** 046 * Create a {@code RawBytesTerminated} using the specified terminator and 047 * {@code order}. 048 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 049 */ 050 public RawBytesTerminated(Order order, String term) { 051 super(new RawBytes(order), term); 052 } 053 054 /** 055 * Create a {@code RawBytesTerminated} using the specified terminator. 056 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 057 */ 058 public RawBytesTerminated(byte[] term) { 059 super(new RawBytes(), term); 060 } 061 062 /** 063 * Create a {@code RawBytesTerminated} using the specified terminator. 064 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 065 */ 066 public RawBytesTerminated(String term) { 067 super(new RawBytes(), term); 068 } 069 070 /** 071 * Read a {@code byte[]} from the buffer {@code src}. 072 */ 073 public byte[] decode(PositionedByteRange src, int length) { 074 return ((RawBytes) wrapped).decode(src, length); 075 } 076 077 /** 078 * Write {@code val} into {@code dst}, respecting {@code offset} and 079 * {@code length}. 080 * @return number of bytes written. 081 */ 082 public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen) { 083 return ((RawBytes) wrapped).encode(dst, val, voff, vlen); 084 } 085}