1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.types;
19
20 import org.apache.hadoop.hbase.classification.InterfaceAudience;
21 import org.apache.hadoop.hbase.classification.InterfaceStability;
22 import org.apache.hadoop.hbase.util.Order;
23 import org.apache.hadoop.hbase.util.OrderedBytes;
24 import org.apache.hadoop.hbase.util.PositionedByteRange;
25
26 /**
27 * Base class for data types backed by the {@link OrderedBytes} encoding
28 * implementations.
29 */
30 @InterfaceAudience.Public
31 @InterfaceStability.Evolving
32 public abstract class OrderedBytesBase<T> implements DataType<T> {
33
34 protected final Order order;
35
36 protected OrderedBytesBase(Order order) { this.order = order; }
37
38 @Override
39 public boolean isOrderPreserving() { return true; }
40
41 @Override
42 public Order getOrder() { return order; }
43
44 // almost all OrderedBytes implementations are nullable.
45 @Override
46 public boolean isNullable() { return true; }
47
48 // almost all OrderedBytes implementations are skippable.
49 @Override
50 public boolean isSkippable() { return true; }
51
52 @Override
53 public int skip(PositionedByteRange src) {
54 return OrderedBytes.skip(src);
55 }
56 }