View Javadoc

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;
19  
20  import java.io.IOException;
21  import java.util.Map;
22  
23  /**
24   * Get, remove and modify table descriptors.
25   * Used by servers to host descriptors.
26   */
27  public interface TableDescriptors {
28    /**
29     * @param tablename
30     * @return HTableDescriptor for tablename
31     * @throws IOException
32     */
33    public HTableDescriptor get(final String tablename)
34    throws IOException;
35  
36    /**
37     * @param tablename
38     * @return HTableDescriptor for tablename
39     * @throws IOException
40     */
41    public HTableDescriptor get(final byte[] tablename)
42    throws IOException;
43  
44    /**
45     * Get Map of all HTableDescriptors. Populates the descriptor cache as a
46     * side effect.
47     * @return Map of all descriptors.
48     * @throws IOException
49     */
50    public Map<String, HTableDescriptor> getAll()
51    throws IOException;
52  
53    /**
54     * Add or update descriptor
55     * @param htd Descriptor to set into TableDescriptors
56     * @throws IOException
57     */
58    public void add(final HTableDescriptor htd)
59    throws IOException;
60  
61    /**
62     * @param tablename
63     * @return Instance of table descriptor or null if none found.
64     * @throws IOException
65     */
66    public HTableDescriptor remove(final String tablename)
67    throws IOException;
68  }