javolution.util.service.MapService Maven / Gradle / Ivy
The newest version!
/*
* Javolution - Java(TM) Solution for Real-Time and Embedded Systems
* Copyright (C) 2012 - Javolution (http://javolution.org/)
* All rights reserved.
*
* Permission to use, copy, modify, and distribute this software is
* freely granted, provided that this notice is preserved.
*/
package javolution.util.service;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ConcurrentMap;
import javolution.util.function.Equality;
import javolution.util.function.Splittable;
/**
* The set of related map functionalities required to implement fast maps.
*
* @author Jean-Marie Dautelle
* @version 6.0, July 21, 2013
* @see javolution.util.FastMap#FastMap()
*/
public interface MapService extends
Map, ConcurrentMap, Splittable>, Serializable, Cloneable {
/**
* Returns a copy of this map; updates of the copy should not
* impact the original.
*/
MapService clone() throws CloneNotSupportedException;
/**
* Returns a set view over the entries of this map. The set
* support adding/removing entries. Two entries are considered
* equals if they have the same key regardless of their values.
*/
@Override
SetService> entrySet();
/**
* Returns an iterator over this map entries.
*/
Iterator> iterator();
/**
* Returns the key comparator used for key equality or order if the
* map is sorted.
*/
Equality keyComparator();
/**
* Returns a set view over the key of this map, the set support
* adding new key for which the value is automatically {@code null}.
*/
@Override
SetService keySet();
/**
* Returns a thread-safe version of this service (used during
* parallel updates).
*/
MapService threadSafe();
/**
* Returns the value comparator used for value equality.
*/
Equality valueComparator();
/**
* Returns a collection view over the values of this map, the collection
* support value/entry removal but not adding new values.
*/
@Override
CollectionService values();
}