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 {@code int} of 32-bits using a fixed-length encoding. Built on
027 * {@link OrderedBytes#encodeInt32(PositionedByteRange, int, Order)}.
028 */
029@InterfaceAudience.Public
030public class OrderedInt32 extends OrderedBytesBase<Integer> {
031
032  public static final OrderedInt32 ASCENDING = new OrderedInt32(Order.ASCENDING);
033  public static final OrderedInt32 DESCENDING = new OrderedInt32(Order.DESCENDING);
034
035  protected OrderedInt32(Order order) {
036    super(order);
037  }
038
039  @Override
040  public boolean isNullable() {
041    return false;
042  }
043
044  @Override
045  public int encodedLength(Integer val) {
046    return 5;
047  }
048
049  @Override
050  public Class<Integer> encodedClass() {
051    return Integer.class;
052  }
053
054  @Override
055  public Integer decode(PositionedByteRange src) {
056    return OrderedBytes.decodeInt32(src);
057  }
058
059  @Override
060  public int encode(PositionedByteRange dst, Integer val) {
061    if (null == val) {
062      throw new IllegalArgumentException("Null values not supported.");
063    }
064    return OrderedBytes.encodeInt32(dst, val, order);
065  }
066
067  /**
068   * Read an {@code int} value from the buffer {@code src}.
069   */
070  public int decodeInt(PositionedByteRange src) {
071    return OrderedBytes.decodeInt32(src);
072  }
073
074  /**
075   * Write instance {@code val} into buffer {@code dst}.
076   */
077  public int encodeInt(PositionedByteRange dst, int val) {
078    return OrderedBytes.encodeInt32(dst, val, order);
079  }
080}