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 * Base class for data types backed by the {@link OrderedBytes} encoding implementations.
027 */
028@InterfaceAudience.Public
029public abstract class OrderedBytesBase<T> implements DataType<T> {
030
031  protected final Order order;
032
033  public OrderedBytesBase(Order order) {
034    this.order = order;
035  }
036
037  @Override
038  public boolean isOrderPreserving() {
039    return true;
040  }
041
042  @Override
043  public Order getOrder() {
044    return order;
045  }
046
047  // almost all OrderedBytes implementations are nullable.
048  @Override
049  public boolean isNullable() {
050    return true;
051  }
052
053  // almost all OrderedBytes implementations are skippable.
054  @Override
055  public boolean isSkippable() {
056    return true;
057  }
058
059  @Override
060  public int skip(PositionedByteRange src) {
061    return OrderedBytes.skip(src);
062  }
063}