com.helger.commons.collection.attr.IMutableAttributeContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.commons.collection.attr;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.state.EChange;
import com.helger.commons.state.IClearable;

/**
 * This is the writable extension of the {@link IAttributeContainer}.
 * null values are not allowed in this attribute containers.
 *
 * @author Philip Helger
 * @param 
 *        Key type
 * @param 
 *        Value type
 */
public interface IMutableAttributeContainer 
                                            extends IAttributeContainer , IClearable
{
  /**
   * Set/overwrite an attribute value.
   *
   * @param aName
   *        The name of the attribute. May not be null.
   * @param aValue
   *        The value of the attribute. If it is null, the value
   *        will be removed.
   * @return {@link EChange#CHANGED} if something changed,
   *         {@link EChange#UNCHANGED} otherwise.
   * @see #removeAttribute(Object)
   */
  @Nonnull
  EChange setAttribute (@Nonnull KEYTYPE aName, @Nullable VALUETYPE aValue);

  /**
   * Set/overwrite an arbitrary number of attribute values.
   *
   * @param aValues
   *        The map of attributes to be set. May be null.
   * @return {@link EChange#CHANGED} if something changed,
   *         {@link EChange#UNCHANGED} otherwise.
   * @see #setAttribute(Object,Object)
   */
  @Nonnull
  EChange setAttributes (@Nullable Map  aValues);

  /**
   * Set/overwrite an arbitrary number of attribute values.
   *
   * @param aValues
   *        The attributes to be set. May be null.
   * @return {@link EChange#CHANGED} if something changed,
   *         {@link EChange#UNCHANGED} otherwise.
   * @see #setAttribute(Object,Object)
   */
  @Nonnull
  EChange setAttributes (@Nullable IAttributeContainer  aValues);

  /**
   * Remove the specified attribute from the container.
   *
   * @param aName
   *        The attribute name to be removed. If it is null nothing
   *        happens.
   * @return {@link EChange#CHANGED} if something changed,
   *         {@link EChange#UNCHANGED} otherwise.
   */
  @Nonnull
  EChange removeAttribute (@Nullable KEYTYPE aName);
}