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