View Javadoc

1   /**
2    * Copyright 2010 The Apache Software Foundation
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  package org.apache.hadoop.hbase.regionserver;
21  
22  /**
23   * Interface to Map of online regions.  In the  Map, the key is the region's
24   * encoded name and the value is an {@link HRegion} instance.
25   */
26  interface OnlineRegions {
27    /**
28     * Add to online regions.
29     * @param r
30     */
31    public void addToOnlineRegions(final HRegion r);
32  
33    /**
34     * This method removes HRegion corresponding to hri from the Map of onlineRegions.
35     *
36     * @param encodedRegionName
37     * @return True if we removed a region from online list.
38     */
39    public boolean removeFromOnlineRegions(String encodedRegionName);
40  
41    /**
42     * Return {@link HRegion} instance.
43     * Only works if caller is in same context, in same JVM. HRegion is not
44     * serializable.
45     * @param encodedRegionName
46     * @return HRegion for the passed encoded <code>encodedRegionName</code> or
47     * null if named region is not member of the online regions.
48     */
49    public HRegion getFromOnlineRegions(String encodedRegionName);
50  }