at.molindo.utils.collections.ListMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molindo-utils Show documentation
Simply utility methods used across other Molindo projects
There is a newer version: 3.0.0
/**
 * Copyright 2010 Molindo GmbH
 *
 * 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 at.molindo.utils.collections;

import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import at.molindo.utils.data.Function;

public class ListMap implements Map> {

	private final Map> _map;

	public static  ListMap newListMap() {
		return new ListMap();
	}

	public static  ListMap build(Iterable c, Function f) {
		ListMap map = newListMap();
		for (E e : c) {
			map.add(f.apply(e), e);
		}
		return map;
	}

	public ListMap() {
		_map = newMap();
	}

	protected Map> newMap() {
		return new HashMap>();
	}

	protected List newList() {
		return new LinkedList();
	}

	protected Map> getMap() {
		return _map;
	}

	@Override
	public void clear() {
		_map.clear();
	}

	@Override
	public boolean containsKey(final Object key) {
		return _map.containsKey(key);
	}

	@Override
	public boolean containsValue(final Object value) {
		return _map.containsValue(value);
	}

	@Override
	public Set>> entrySet() {
		return _map.entrySet();
	}

	@Override
	public boolean equals(final Object o) {
		return _map.equals(o);
	}

	@Override
	public List get(final Object key) {
		return _map.get(key);
	}

	@Override
	public int hashCode() {
		return _map.hashCode();
	}

	@Override
	public boolean isEmpty() {
		return _map.isEmpty();
	}

	@Override
	public Set keySet() {
		return _map.keySet();
	}

	public boolean add(final T key, final E value) {
		return getList(key).add(value);
	}

	public boolean addAll(final T key, final Collection values) {
		return getList(key).addAll(values);
	}

	@Override
	public List put(final T key, final List value) {
		return _map.put(key, value);
	}

	@Override
	public void putAll(final Map> m) {
		_map.putAll(m);
	}

	@Override
	public List remove(final Object key) {
		return _map.remove(key);
	}

	public boolean removeValue(final T key, final E value) {
		final List list = _map.get(key);
		return list == null ? false : list.remove(value);
	}

	@Override
	public int size() {
		return _map.size();
	}

	@Override
	public Collection> values() {
		return _map.values();
	}

	@Override
	public String toString() {
		return ListMap.class.getSimpleName() + ": " + _map;
	}

	public List getList(final T key) {
		List list = _map.get(key);
		if (list == null) {
			list = newList();
			_map.put(key, list);
		}
		return list;
	}

}