net.automatalib.commons.util.mappings.MapMapping Maven / Gradle / Ivy

Go to download

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

Basic utility library containing several useful classes (e.g., a Pair class) to ease everyday programming.

There is a newer version: 0.11.0

Show newest version

/* Copyright (C) 2013 TU Dortmund
 * This file is part of AutomataLib, http://www.automatalib.net/.
 * 
 * AutomataLib is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 3.0 as published by the Free Software Foundation.
 * 
 * AutomataLib 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with AutomataLib; if not, see
 * http://www.gnu.de/documents/lgpl.en.html.
 */
package net.automatalib.commons.util.mappings;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * Class that wraps a {@link Mapping} around a {@link java.util.Map}.
 * 
 * @author Malte Isberner
 *
 * @param  domain type.
 * @param  range type.
 */
public class MapMapping implements MutableMapping {
	
	public static  MapMapping create(Map map) {
		return new MapMapping(map);
	}
	
	
	private final Map map;
	
	public MapMapping(Map map, boolean copy) {
		if(!copy)
			this.map = map;
		else
			this.map = new HashMap();
	}
	
	/**
	 * Constructor.
	 * @param map the underlying {@link java.util.Map} object.
	 */
	public MapMapping(Map map) {
		this.map = map;
	}
	
	public MapMapping() {
		this(new HashMap());
	}
	
	/*
	 * (non-Javadoc)
	 * @see edu.udo.ls5.util.Mapping#get(java.lang.Object)
	 */
	@Override
	public R get(D elem) {
		return map.get(elem);
	}
	
	/**
	 * Delegates to the underlying {@link java.util.Map}.
	 * @see java.util.Map#put(Object, Object)
	 */
	@Override
	public R put(D key, R value) {
		return map.put(key, value);
	}
	
	/**
	 * Delegates to the underlying {@link java.util.Map}.
	 * @see java.util.Map#entrySet()
	 */
	public Set> entrySet() {
		return map.entrySet();
	}
}