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  
20  package org.apache.hadoop.hbase.client;
21  
22  import java.util.Map;
23  
24  import org.apache.hadoop.hbase.classification.InterfaceAudience;
25  import org.apache.hadoop.hbase.classification.InterfaceStability;
26  
27  @InterfaceAudience.Public
28  @InterfaceStability.Stable
29  public interface Attributes {
30    /**
31     * Sets an attribute.
32     * In case value = null attribute is removed from the attributes map.
33     * Attribute names starting with _ indicate system attributes.
34     * @param name attribute name
35     * @param value attribute value
36     */
37    Attributes setAttribute(String name, byte[] value);
38  
39    /**
40     * Gets an attribute
41     * @param name attribute name
42     * @return attribute value if attribute is set, <tt>null</tt> otherwise
43     */
44    byte[] getAttribute(String name);
45  
46    /**
47     * Gets all attributes
48     * @return unmodifiable map of all attributes
49     */
50    Map<String, byte[]> getAttributesMap();
51  }