JAVA Map架构和API介绍
首先,我们看看map架构。
如上图:
map 是映射接口,map中存储的内容是键值对(key-value)。
abstractmap 是继承于map的抽象类,它实现了map中的大部分api。其它map的实现类可以通过继承abstractmap来减少重复编码。
sortedmap 是继承于map的接口。sortedmap中的内容是排序的键值对,排序的方法是通过比较器(comparator)。
navigablemap 是继承于sortedmap的接口。相比于sortedmap,navigablemap有一系列的导航方法;如"获取大于/等于某对象的键值对"、“获取小于/等于某对象的键值对”等等。
treemap 继承于abstractmap,且实现了navigablemap接口;因此,treemap中的内容是“有序的键值对”!
hashmap 继承于abstractmap,但没实现navigablemap接口;因此,hashmap的内容是“键值对,但不保证次序”!
hashtable 虽然不是继承于abstractmap,但它继承于dictionary(dictionary也是键值对的接口),而且也实现map接口;因此,hashtable的内容也是“键值对,也不保证次序”。但和hashmap相比,hashtable是线程安全的,而且它支持通过enumeration去遍历。
weakhashmap 继承于abstractmap。它和hashmap的键类型不同,weakhashmap的键是“弱键”。
有了上面的总体框架之后,我们先来看看各个接口和抽象类的介绍;后面再对各个实现类进行详细说明。
1 map
map的定义如下:
public interface map<k,v> { }
map 是一个键值对(key-value)映射接口。map映射中不能包含重复的键;每个键最多只能映射到一个值。
map 接口提供三种collection 视图,允许以键集、值集或键-值映射关系集的形式查看某个映射的内容。
map 映射顺序。有些实现类,可以明确保证其顺序,如 treemap;另一些映射实现则不保证顺序,如 hashmap 类。
map 的实现类应该提供2个“标准的”构造方法:第一个,void(无参数)构造方法,用于创建空映射;第二个,带有单个 map 类型参数的构造方法,用于创建一个与其参数具有相同键-值映射关系的新映射。实际上,后一个构造方法允许用户复制任意映射,生成所需类的一个等价映射。尽管无法强制执行此建议(因为接口不能包含构造方法),但是 jdk 中所有通用的映射实现都遵从它。
map的api
abstract void clear()
abstract boolean containskey(object key)
abstract boolean containsvalue(object value)
abstract set<entry<k, v>> entryset()
abstract boolean equals(object object)
abstract v get(object key)
abstract int hashcode()
abstract boolean isempty()
abstract set<k> keyset()
abstract v put(k key, v value)
abstract void putall(map<? extends k, ? extends v> map)
abstract v remove(object key)
abstract int size()
abstract collection<v> values()
说明:
(01) map提供接口分别用于返回 键集、值集或键-值映射关系集。
entryset()用于返回键-值集的set集合
keyset()用于返回键集的set集合
values()用户返回值集的collection集合
因为map中不能包含重复的键;每个键最多只能映射到一个值。所以,键-值集、键集都是set,值集时collection。
(02) map提供了“键-值对”、“根据键获取值”、“删除键”、“获取容量大小”等方法。
2 map.entry
map.entry的定义如下:
interface entry<k,v> { }
map.entry是map中内部的一个接口,map.entry是键值对,map通过 entryset() 获取map.entry的键值对集合,从而通过该集合实现对键值对的操作。
map.entry的api
abstract boolean equals(object object)
abstract k getkey()
abstract v getvalue()
abstract int hashcode()
abstract v setvalue(v object)
3 abstractmap
abstractmap的定义如下:
public abstract class abstractmap<k,v> implements map<k,v> {}
abstractmap类提供 map 接口的骨干实现,以最大限度地减少实现此接口所需的工作。
要实现不可修改的映射,编程人员只需扩展此类并提供 entryset 方法的实现即可,该方法将返回映射的映射关系 set 视图。通常,返回的 set 将依次在 abstractset 上实现。此 set 不支持 add() 或 remove() 方法,其迭代器也不支持 remove() 方法。
要实现可修改的映射,编程人员必须另外重写此类的 put 方法(否则将抛出 unsupportedoperationexception),entryset().iterator() 返回的迭代器也必须另外实现其 remove 方法。
abstractmap的api
abstract set<entry<k, v>> entryset()
void clear()
boolean containskey(object key)
boolean containsvalue(object value)
boolean equals(object object)
v get(object key)
int hashcode()
boolean isempty()
set<k> keyset()
v put(k key, v value)
void putall(map<? extends k, ? extends v> map)
v remove(object key)
int size()
string tostring()
collection<v> values()
object clone()
4 sortedmap
sortedmap的定义如下:
public interface sortedmap<k,v> extends map<k,v> { }
sortedmap是一个继承于map接口的接口。它是一个有序的sortedmap键值映射。
sortedmap的排序方式有两种:自然排序 或者 用户指定比较器。 插入有序 sortedmap 的所有元素都必须实现 comparable 接口(或者被指定的比较器所接受)。
另外,所有sortedmap 实现类都应该提供 4 个“标准”构造方法:
(01) void(无参数)构造方法,它创建一个空的有序映射,按照键的自然顺序进行排序。
(02) 带有一个 comparator 类型参数的构造方法,它创建一个空的有序映射,根据指定的比较器进行排序。
(03) 带有一个 map 类型参数的构造方法,它创建一个新的有序映射,其键-值映射关系与参数相同,按照键的自然顺序进行排序。
(04) 带有一个 sortedmap 类型参数的构造方法,它创建一个新的有序映射,其键-值映射关系和排序方法与输入的有序映射相同。无法保证强制实施此建议,因为接口不能包含构造方法。
sortedmap的api
// 继承于map的api
abstract void clear()
abstract boolean containskey(object key)
abstract boolean containsvalue(object value)
abstract set<entry<k, v>> entryset()
abstract boolean equals(object object)
abstract v get(object key)
abstract int hashcode()
abstract boolean isempty()
abstract set<k> keyset()
abstract v put(k key, v value)
abstract void putall(map<? extends k, ? extends v> map)
abstract v remove(object key)
abstract int size()
abstract collection<v> values()
// sortedmap新增的api
abstract comparator<? super k> comparator()
abstract k firstkey()
abstract sortedmap<k, v> headmap(k endkey)
abstract k lastkey()
abstract sortedmap<k, v> submap(k startkey, k endkey)
abstract sortedmap<k, v> tailmap(k startkey)
5 navigablemap
navigablemap的定义如下:
public interface navigablemap<k,v> extends sortedmap<k,v> { }
navigablemap是继承于sortedmap的接口。它是一个可导航的键-值对集合,具有了为给定搜索目标报告最接近匹配项的导航方法。
navigablemap分别提供了获取“键”、“键-值对”、“键集”、“键-值对集”的相关方法。
navigablemap的api
abstract entry<k, v> ceilingentry(k key)
abstract entry<k, v> firstentry()
abstract entry<k, v> floorentry(k key)
abstract entry<k, v> higherentry(k key)
abstract entry<k, v> lastentry()
abstract entry<k, v> lowerentry(k key)
abstract entry<k, v> pollfirstentry()
abstract entry<k, v> polllastentry()
abstract k ceilingkey(k key)
abstract k floorkey(k key)
abstract k higherkey(k key)
abstract k lowerkey(k key)
abstract navigableset<k> descendingkeyset()
abstract navigableset<k> navigablekeyset()
abstract navigablemap<k, v> descendingmap()
abstract navigablemap<k, v> headmap(k tokey, boolean inclusive)
abstract sortedmap<k, v> headmap(k tokey)
abstract sortedmap<k, v> submap(k fromkey, k tokey)
abstract navigablemap<k, v> submap(k fromkey, boolean frominclusive, k tokey, boolean toinclusive)
abstract sortedmap<k, v> tailmap(k fromkey)
abstract navigablemap<k, v> tailmap(k fromkey, boolean inclusive)
说明:
navigablemap除了继承sortedmap的特性外,它的提供的功能可以分为4类:
第1类,提供操作键-值对的方法。
lowerentry、floorentry、ceilingentry 和 higherentry 方法,它们分别返回与小于、小于等于、大于等于、大于给定键的键关联的 map.entry 对象。
firstentry、pollfirstentry、lastentry 和 polllastentry 方法,它们返回和/或移除最小和最大的映射关系(如果存在),否则返回 null。
第2类,提供操作键的方法。这个和第1类比较类似
lowerkey、floorkey、ceilingkey 和 higherkey 方法,它们分别返回与小于、小于等于、大于等于、大于给定键的键。
第3类,获取键集。
navigablekeyset、descendingkeyset分别获取正序/反序的键集。
第4类,获取键-值对的子集。
6 dictionary
dictionary的定义如下:
public abstract class dictionary<k,v> {}
navigablemap是jdk 1.0定义的键值对的接口,它也包括了操作键值对的基本函数。
dictionary的api
abstract enumeration<v> elements()
abstract v get(object key)
abstract boolean isempty()
abstract enumeration<k> keys()
abstract v put(k key, v value)
abstract v remove(object key)
abstract int