View Javadoc

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