com.rapiddweller.common.collection.NameMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation

'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 2.0.1-jdk-11

Show newest version

/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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.rapiddweller.common.collection;

import com.rapiddweller.common.Named;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * A {@link Map} which offers convenience methods for managing {@link Named} objects
 * in a Map semantics by their name property.
 * Created: 06.06.2012 20:15:36
 *
 * @param  the type of the collection's elements
 * @author Volker Bergmann
 * @since 0.5.16
 */
public class NameMap extends HashMap {

  private static final long serialVersionUID = -4765030342987297182L;

  /**
   * Instantiates a new Name map.
   */
  public NameMap() {
    super();
  }

  /**
   * Instantiates a new Name map.
   *
   * @param initialCapacity the initial capacity
   * @param loadFactor      the load factor
   */
  public NameMap(int initialCapacity, float loadFactor) {
    super(initialCapacity, loadFactor);
  }

  /**
   * Instantiates a new Name map.
   *
   * @param initialCapacity the initial capacity
   */
  public NameMap(int initialCapacity) {
    super(initialCapacity);
  }

  /**
   * Instantiates a new Name map.
   *
   * @param prototype the prototype
   */
  public NameMap(Collection prototype) {
    super(prototype.size());
    for (E item : prototype) {
      super.put(item.getName(), item);
    }
  }

  /**
   * Instantiates a new Name map.
   *
   * @param elements the elements
   */
  @SafeVarargs
  public NameMap(E... elements) {
    super(elements.length);
    for (E element : elements) {
      super.put(element.getName(), element);
    }
  }

  /**
   * Put.
   *
   * @param item the item
   */
  public void put(E item) {
    super.put(item.getName(), item);
  }

}