List:有序的collection(也称为序列)。此接口的用户可以对列表中每个元素的插入位置进行精确地控制。用户可以根据元素的整数索引(在列表中的位置)访问元素,并搜索列表中的元素。
set 不同,列表通常允许重复的元素。更正式地说,列表通常允许满足 e1.equals(e2) 的元素对 e1 和 e2,并且如果列表本身允许 null 元素的话,通常它们允许多个 null 元素。难免有人希望通过在用户尝试插入重复元素时抛出运行时异常的方法来禁止重复的列表,但我们希望这种用法越少越好。
List 接口在 iterator、add、remove、equals 和 hashCode 方法的协定上加了一些其他约定,超过了 Collection
List 接口提供了 4 种对列表元素进行定位(索引)访问方法。列表(像 Java 数组一样)是基于 0 的。注意,这些操作可能在和某些实现(例如 LinkedList
List 接口提供了特殊的迭代器,称为 ListIterator,除了允许 Iterator
List
List
注意:尽管列表允许把自身作为元素包含在内,但建议要特别小心:在这样的列表上,equals 和 hashCode
某些列表实现对列表可能包含的元素有限制。例如,某些实现禁止 null 元素,而某些实现则对元素的类型有限制。试图添加不合格的元素会抛出未经检查的异常,通常是 NullPointerException 或 ClassCastException。试图查询不合格的元素是否存在可能会抛出异常,也可能简单地返回 false;某些实现会采用前一种行为,而某些则采用后者。概括地说,试图对不合格元素执行操作时,如果完成该操作后不会导致在列表中插入不合格的元素,则该操作可能抛出一个异常,也可能成功,这取决于实现的选择。此接口的规范中将这样的异常标记为“可选”。
方法详细信息
int size() 返回列表中的元素数。
boolean isEmpty() 如果列表不包含元素,则返回true。
boolean contains(Object o) 如果列表包含指定的元素,则返回 true。
Iterator<E> iterator() 返回以正确顺序在列表的元素上进行迭代的迭代器。
Object[] toArray() 返回以正确顺序包含该列表中所有元素的数组。
<T> T[] toArray(T[] a) 返回包含列表中元素的数组。
boolean add(E o) 返回true。
boolean remove(object o) 如果列表包含指定的元素,则返回 true。
boolean containAll(Contain<?> c) 如果列表包含指定 collection 的所有元素,则返回 true。
boolean addAll(Collection<? extends E> c) 如果此列表随调用的结果发生改变,则返回 true。
boolean addAll(int index,Collection<? extends E> c) 如果此列表随调用的结果发生改变,则返回 true。
boolean removeAll(Collection<?> c) 如果此列表随调用的结果发生改变,则返回 true。
boolean retainAll(Collection<?> c) 如果此列表随调用的结果发生改变,则返回 true。
void clear() 从列表中移除所有元素(可选操作)。此调用返回后列表将是空的(除非它抛出异常)。
boolean equals(Object o) 如果指定对象与此列表相等,则返回 true。
int hashCode()//返回列表的哈希码值。列表的哈希码定义为以下计算的结果:
hashCode = 1;
Iterator i = list.iterator();
while (i.hasNext()) {
Object obj = i.next();
hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
}
//这确保了 list1.equals(list2) 意味着对于任何两个列表 list1 和 list2 而言,可实现 //list1.hashCode()==list2.hashCode(),正如 Object.hashCode 的常规协定所要求的。
E get(int index)返回列表中指定位置的元素。
E set(int index,
E element)用指定元素替换列表中指定位置的元素(可选操作)。
void add(int index,E element)在列表的指定位置插入指定元素(可选操作)。将当前处于该位置的元素(如果有的话)和所有后续元素向右移动(在其索引中加 1)。
E remove(int index)移除列表中指定位置的元素(可选操作)。将所有的后续元素向左移动(将其索引减 1)。返回从列表中移除的元素。
int indexOf(Object o)返回列表中首次出现指定元素的索引,如果列表不包含此元素,则返回 -1。更正式地说,返回满足下面条件的最低索引 i:(o==null ? get(i)==null :o.equals(get(i))),如果没有这样的索引,则返回 -1。
int lastIndexOf(Object o)返回列表中最后出现指定元素的索引,如果列表不包含此元素,则返回 -1。更正式地说,返回满足下面条件的最高索引 i:(o==null ? get(i)==null :o.equals(get(i))),如果没有这样的索引,则返回 -1。
ListIterator<E> listIterator()返回列表中元素的列表迭代器(以正确的顺序)。
ListIterator<E> listIterator(int index)返回列表中元素的列表迭代器(以正确的顺序),从列表的指定位置开始。指定的索引指出会由 next 方法的初始调用所返回的首个元素。previous 方法的初始调用会返回索引比指定索引少 1 的元素。
List<E> subList(int fromIndex,
int toIndex)返回列表中指定的 fromIndex(包括 )和 toIndex(不包括)之间的部分视图。(如果 fromIndex 和 toIndex 相等,则返回的列表为空)。返回的列表由此列表支持,因此返回列表中的非结构性更改将反映在此列表中,反之亦然。返回的列表支持此列表支持的所有可选列表操作。
此方法省去了显式范围操作(此操作通常针对数组存在)。通过传递 subList 视图而非整个列表,期望列表的任何操作可用作范围操作。例如,下面的语句从列表中移除了元素的范围:
list.subList(from, to).clear();
可以对 indexOf 和 lastIndexOf 构造类似的语句,而且 Collections 类中的所有算法都可以应用于 subList。
如果支持列表(即此列表)通过任何其他方式(而不是通过返回的列表)从结构上修改,则此方法返回的列表语义将变为未定义(从结构上修改是指更改列表的大小,或者以其他方式打乱列表,使正在进行的迭代产生错误的结果)。