infra.beans.factory.support.ManagedMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of today-beans Show documentation
Infra Beans
The newest version!
/*
 * Copyright 2017 - 2024 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see [https://www.gnu.org/licenses/]
 */

package infra.beans.factory.support;

import java.util.LinkedHashMap;
import java.util.Map;

import infra.beans.BeanMetadataElement;
import infra.beans.Mergeable;
import infra.lang.Nullable;

/**
 * Tag collection class used to hold managed Map values, which may
 * include runtime bean references (to be resolved into bean objects).
 *
 * @param  the key type
 * @param  the value type
 * @author Juergen Hoeller
 * @author Rob Harrop
 * @author Harry Yang
 * @since 4.0
 */
@SuppressWarnings("serial")
public class ManagedMap extends LinkedHashMap implements Mergeable, BeanMetadataElement {

  @Nullable
  private Object source;

  @Nullable
  private String keyTypeName;

  @Nullable
  private String valueTypeName;

  private boolean mergeEnabled;

  public ManagedMap() {
  }

  public ManagedMap(int initialCapacity) {
    super(initialCapacity);
  }

  /**
   * Set the configuration source {@code Object} for this metadata element.
   * The exact type of the object will depend on the configuration mechanism used.
   */
  public void setSource(@Nullable Object source) {
    this.source = source;
  }

  @Override
  @Nullable
  public Object getSource() {
    return this.source;
  }

  /**
   * Set the default key type name (class name) to be used for this map.
   */
  public void setKeyTypeName(@Nullable String keyTypeName) {
    this.keyTypeName = keyTypeName;
  }

  /**
   * Return the default key type name (class name) to be used for this map.
   */
  @Nullable
  public String getKeyTypeName() {
    return this.keyTypeName;
  }

  /**
   * Set the default value type name (class name) to be used for this map.
   */
  public void setValueTypeName(@Nullable String valueTypeName) {
    this.valueTypeName = valueTypeName;
  }

  /**
   * Return the default value type name (class name) to be used for this map.
   */
  @Nullable
  public String getValueTypeName() {
    return this.valueTypeName;
  }

  /**
   * Set whether merging should be enabled for this collection,
   * in case of a 'parent' collection value being present.
   */
  public void setMergeEnabled(boolean mergeEnabled) {
    this.mergeEnabled = mergeEnabled;
  }

  @Override
  public boolean isMergeEnabled() {
    return this.mergeEnabled;
  }

  @Override
  @SuppressWarnings("unchecked")
  public Object merge(@Nullable Object parent) {
    if (!this.mergeEnabled) {
      throw new IllegalStateException("Not allowed to merge when the 'mergeEnabled' property is set to 'false'");
    }
    if (parent == null) {
      return this;
    }
    if (!(parent instanceof Map)) {
      throw new IllegalArgumentException("Cannot merge with object of type [" + parent.getClass() + "]");
    }
    Map merged = new ManagedMap<>();
    merged.putAll((Map) parent);
    merged.putAll(this);
    return merged;
  }

  /**
   * Return a new instance containing keys and values extracted from the
   * given entries. The entries themselves are not stored in the map.
   *
   * @param entries {@code Map.Entry}s containing the keys and values
   * from which the map is populated
   * @param  the {@code Map}'s key type
   * @param  the {@code Map}'s value type
   * @return a {@code Map} containing the specified mappings
   */
  @SuppressWarnings("unchecked")
  public static  ManagedMap ofEntries(Map.Entry... entries) {
    ManagedMap map = new ManagedMap<>();
    for (Map.Entry entry : entries) {
      map.put(entry.getKey(), entry.getValue());
    }
    return map;
  }

}