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 fixed-length values encoded using
026 * {@link org.apache.hadoop.hbase.util.Bytes#putBytes(
027 * byte[], int, byte[], int, int)}. Intended to make it
028 * easier to transition away from direct use of 
029 * {@link org.apache.hadoop.hbase.util.Bytes}.
030 * @see org.apache.hadoop.hbase.util.Bytes#putBytes(byte[], int, byte[], int, int)
031 * @see RawBytes
032 * @see OrderedBlob
033 * @see OrderedBlobVar
034 */
035@InterfaceAudience.Public
036public class RawBytesFixedLength extends FixedLengthWrapper<byte[]> {
037
038  /**
039   * Create a {@code RawBytesFixedLength} using the specified {@code order}
040   * and {@code length}.
041   */
042  public RawBytesFixedLength(Order order, int length) {
043    super(new RawBytes(order), length);
044  }
045
046  /**
047   * Create a {@code RawBytesFixedLength} of the specified {@code length}.
048   */
049  public RawBytesFixedLength(int length) {
050    super(new RawBytes(Order.ASCENDING), length);
051  }
052
053  /**
054   * Read a {@code byte[]} from the buffer {@code src}.
055   */
056  public byte[] decode(PositionedByteRange src, int length) {
057    return ((RawBytes) base).decode(src, length);
058  }
059
060  /**
061   * Write {@code val} into {@code buff}, respecting {@code offset} and
062   * {@code length}.
063   */
064  public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen) {
065    return ((RawBytes) base).encode(dst, val, voff, vlen);
066  }
067}