8.3.4 EnumSet类

EnumSet是一个专为枚举类设计的集合类, EnumSet中的所有元素都必须是指定枚举类型的枚举值,该枚举类型在创建EnumSet时显式或隐式地指定。

EnumSet有序

EnumSet的集合元素也是有序的, EnumSet以枚举值在Enum类内的定义顺序来决定集合元素的顺序。

EnumSet以向量存储 内存占用小

EnumSet在内部以位向量的形式存储,这种存储形式非常紧凑、高效,因此EnumSet对象占用内存很小,而且运行效率很好,尤其是调用containsAll(),retainAll()等方法来进行批量操作时。如果其参数也是EnumSet集合,则该批量操作的执行速度也非常快。

EnumSet中不能加入null

EnumSet集合不允许加入null元素,如果试图插入null元素, EnumSet将抛出NullPointerException异常。如果只是想判断EnumSet是否包含null元素或试图删除null元素都不会抛出异常,只是删除操作将返回false,因为EnumSet中无法存入null,所以根本没有任何null元素被删除。

EnumSet不提供构造器,通过类方法来创建EnumSet对象

EnumSet类没有暴露任何构造器来创建该类的实例,程序应该通过它提供的类方法来创建EnumSet对象。

常用EnumSet类方法

EnumSet类它提供了如下常用的类方法来创建EnumSet对象。

创建所有枚举值构成的EnumSet

方法	描述
static <E extends Enum<E>> EnumSet<E> allOf(Class<E> elementType)	创建一个包含指定枚举类里所有枚举值的EnumSet集合。

创建EnumSet的补集构成的EnumSet

方法	描述
static <E extends Enum<E>> EnumSet<E> complementOf(EnumSet<E> s)	创建一个其元素类型与指定EnumSet里元素类型相同的EnumSet集合,新EnumSet集合包含原EnumSet集合所不包含的、此枚举类剩下的枚举值(即新EnumSet集合和原EnumSet集合的集合元素加起来就是该枚举类的所有枚举值)。就是类似求差集

复制Collection集合或者其他EnumSet中的所有元素来创建EnumSet

方法	描述
static <E extends Enum<E>> EnumSet<E> copyOf(Collection<E> c)	使用一个普通集合来创建EnumSet集合。
static <E extends Enum<E>> EnumSet<E> copyOf(EnumSet<E> s)	Creates an enum set with the same element type as the specified enum set, initially containing the same elements (if any).

创建 指定枚举类型的 空的EnumSet

方法	描述
static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType)	创建一个元素类型为指定枚举类型的空EnumSet

直接给定的枚举值来创建EnumSet

of方法可以创建一个包含一个或多个枚举值的EnumSet集合,传入的多个枚举值必须属于同一个枚举类。

方法	描述
static <E extends Enum<E>> EnumSet<E> of(E e)	Creates an enum set initially containing the specified element.
static <E extends Enum<E>> EnumSet<E> of(E e1, E e2)	Creates an enum set initially containing the specified elements.
static <E extends Enum<E>> EnumSet<E> of(E first, E... rest)	Creates an enum set initially containing the specified elements.
static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3)	Creates an enum set initially containing the specified elements.
static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4)	Creates an enum set initially containing the specified elements.
static <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4, E e5)	Creates an enum set initially containing the specified elements.

创建指定区间之间的枚举值构成的EnumeSet

方法	描述
static <E extends Enum<E>> EnumSet<E> range(E from, E to)	创建一个包含从from枚举值到to枚举值范围内所有枚举值的EnumSet集合。

程序 创建EnumSet的各种姿势

下面程序示范了如何使用EnumSet来保存枚举类的多个枚举值。

import java.util.*;

enum Season
{
    SPRING,SUMMER,FALL,WINTER
}
public class EnumSetTest
{
    public static void main(String[] args)
    {
        // 创建一个EnumSet集合，集合元素就是Season枚举类的全部枚举值
        EnumSet es1 = EnumSet.allOf(Season.class);
        System.out.println(es1); // 输出[SPRING,SUMMER,FALL,WINTER]

        // 创建一个EnumSet空集合，指定其集合元素是Season类的枚举值。
        EnumSet es2 = EnumSet.noneOf(Season.class);
        System.out.println(es2); // 输出[]

        // 手动添加两个元素
        es2.add(Season.WINTER);
        es2.add(Season.SPRING);
        System.out.println(es2); // 输出[SPRING,WINTER]

        // 以指定枚举值创建EnumSet集合
        EnumSet es3 = EnumSet.of(Season.SUMMER , Season.WINTER);
        System.out.println(es3); // 输出[SUMMER,WINTER]

        EnumSet es4 = EnumSet.range(Season.SUMMER , Season.WINTER);
        System.out.println(es4); // 输出[SUMMER,FALL,WINTER]

        // 新创建的EnumSet集合的元素和es4集合的元素有相同类型，
        // es5的集合元素 + es4集合元素 = Season枚举类的全部枚举值
        EnumSet es5 = EnumSet.complementOf(es4);
        System.out.println(es5); // 输出[SPRING]
    }
}

运行效果:

[SPRING, SUMMER, FALL, WINTER]
[]
[SPRING, WINTER]
[SUMMER, WINTER]
[SUMMER, FALL, WINTER]
[SPRING]

通过复制集合中的元素来创建EnumSet

除此之外,还可以复制另一个EnumSet集合中的所有元素来创建新的EnumSet集合,或者复制另一个Collection集合中的所有元素来创建新的EnumSet集合。当复制Collection集合中的所有元素来创建新的EnumSet集合时,要求Collection集合中的所有元素必须是同一个枚举类的枚举值。

复制Collection来创建EnumSet的前提

当试图复制一个Collection集合里的元素来创建EnumSet集合时,必须保证Collection集合里的所有元素都是同一个枚举类的枚举值

程序 复制集合中的元素来创建EnumSet

下面程序示范了这个用法。

import java.util.*;

public class EnumSetTest2
{
    public static void main(String[] args)
    {
        Collection c = new HashSet();
        c.clear();
        c.add(Season.FALL);
        c.add(Season.SPRING);

        // 复制Collection集合中所有元素来创建EnumSet集合
        EnumSet enumSet = EnumSet.copyOf(c);   // ①
        System.out.println(enumSet); // 输出[SPRING,FALL]

        c.add("疯狂Java讲义");
        c.add("轻量级Java EE企业应用实战");
        // 下面代码出现异常：因为c集合里的元素不是全部都为枚举值
        enumSet = EnumSet.copyOf(c);  // ②
    }
}

上面程序中表示的①,和②处的代码没有任何区别,只是因为执行②行代码时,c集合中的元素不全是枚举值,而是包含了两个字符串对象,所以在②行代码处抛出ClassCastException异常