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