View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.util;
20  
21  import org.apache.hadoop.hbase.classification.InterfaceAudience;
22  
23  /**
24   * Similar interface as {@link org.apache.hadoop.util.Progressable} but returns
25   * a boolean to support canceling the operation.
26   * <p>
27   * Used for doing updating of OPENING znode during log replay on region open.
28   */
29  @InterfaceAudience.Private
30  public interface CancelableProgressable {
31  
32    /**
33     * Report progress.  Returns true if operations should continue, false if the
34     * operation should be canceled and rolled back.
35     * @return whether to continue (true) or cancel (false) the operation
36     */
37    boolean progress();
38  
39  }