hbase-common/src/main/java/org/apache/hadoop/hbase/Stoppable.java

   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;
  20
  21 import org.apache.yetus.audience.InterfaceAudience;
  22
  23 /**
  24  * Implementers are Stoppable.
  25  */
  26 @InterfaceAudience.Public
  27 public interface Stoppable {
  28   /**
  29    * Stop this service.
  30    * Implementers should favor logging errors over throwing RuntimeExceptions.
  31    * @param why Why we're stopping.
  32    */
  33   void stop(String why);
  34
  35   /**
  36    * @return True if {@link #stop(String)} has been closed.
  37    */
  38   boolean isStopped();
  39 }