001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import java.util.Map;
021import org.apache.yetus.audience.InterfaceAudience;
022
023@InterfaceAudience.Public
024public interface Attributes {
025  /**
026   * Sets an attribute. In case value = null attribute is removed from the attributes map. Attribute
027   * names starting with _ indicate system attributes.
028   * @param name  attribute name
029   * @param value attribute value
030   */
031  Attributes setAttribute(String name, byte[] value);
032
033  /**
034   * Gets an attribute
035   * @param name attribute name
036   * @return attribute value if attribute is set, <tt>null</tt> otherwise
037   */
038  byte[] getAttribute(String name);
039
040  /**
041   * Gets all attributes
042   * @return unmodifiable map of all attributes
043   */
044  Map<String, byte[]> getAttributesMap();
045}