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.regionserver.compactions;
19
20 import org.apache.hadoop.hbase.classification.InterfaceAudience;
21
22 /**
23 * Base class for compaction window implementation.
24 */
25 @InterfaceAudience.Private
26 public abstract class CompactionWindow {
27
28 /**
29 * Compares the window to a timestamp.
30 * @param timestamp the timestamp to compare.
31 * @return a negative integer, zero, or a positive integer as the window lies before, covering, or
32 * after than the timestamp.
33 */
34 public abstract int compareToTimestamp(long timestamp);
35
36 /**
37 * Move to the new window of the same tier or of the next tier, which represents an earlier time
38 * span.
39 * @return The next earlier window
40 */
41 public abstract CompactionWindow nextEarlierWindow();
42
43 /**
44 * Inclusive lower bound
45 */
46 public abstract long startMillis();
47
48 /**
49 * Exclusive upper bound
50 */
51 public abstract long endMillis();
52
53 @Override
54 public String toString() {
55 return "[" + startMillis() + ", " + endMillis() + ")";
56 }
57 }