package nl.tudelft.simulation.immutablecollections;
import java.util.HashMap;
import java.util.Map;
import nl.tudelft.simulation.language.Throw;
/**
* An immutable wrapper for a HashMap.
*
* Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* BSD-style license. See DSOL License.
*
* $LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $,
* initial version May 7, 2016
* @author Alexander Verbraeck
* @author Peter Knoppers
* @author Wouter Schakel
* @param the key type of content of this Map
* @param the value type of content of this Map
*/
public class ImmutableLinkedHashMap extends ImmutableHashMap
{
/** */
private static final long serialVersionUID = 20160507L;
/**
* @param map the map to use as the immutable map.
*/
public ImmutableLinkedHashMap(final Map map)
{
this(map, Immutable.COPY);
}
/**
* @param map the map to use as the immutable map.
* @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
*/
public ImmutableLinkedHashMap(final Map map, final Immutable copyOrWrap)
{
super(copyOrWrap == Immutable.COPY ? new HashMap(map) : map, copyOrWrap == Immutable.COPY);
Throw.whenNull(copyOrWrap, "the copyOrWrap argument should be Immutable.COPY or Immutable.WRAP");
}
/**
* @param immutableMap the map to use as the immutable map.
*/
public ImmutableLinkedHashMap(final ImmutableHashMap immutableMap)
{
this(immutableMap, Immutable.COPY);
}
/**
* @param immutableMap the map to use as the immutable map.
* @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
*/
public ImmutableLinkedHashMap(final ImmutableHashMap immutableMap, final Immutable copyOrWrap)
{
this(((ImmutableAbstractMap) immutableMap).getMap(), copyOrWrap);
}
/**
* @param immutableMap the set to use as the immutable set.
*/
public ImmutableLinkedHashMap(final ImmutableLinkedHashMap immutableMap)
{
this(immutableMap.toMap());
}
/** {@inheritDoc} */
@Override
public final String toString()
{
Map map = getMap();
if (null == map)
{
return "ImmutableLinkedHashMap []";
}
return "ImmutableLinkedHashMap [" + map.toString() + "]";
}
}