Java枚举

枚举是限定有限可能值的一种手段,使用枚举可以降低程序出错的几率,并可以提高代码的可读性与可维护性。Java中的枚举并不是简单常量的集合,而是一个对象,其本质依然是类,所以Java中的枚举除了提供一系列相关值以外,还提供了一些额外功能,甚至还可以根据需要自行添加一些功能。本文拟就Java枚举的用法做一相对全面的介绍。

一、            常规用法

尽管Java中的枚举是对象,但是大多数使用它的场景与其它语言中并无二致,因此其使用形式也大抵相同。

1.        定义

定义枚举需要使用关键字enum。例如一个应用需要使用一系列特定的颜色值,则可以定义一个类似以下形式的枚举。

enum MyColor

{

RED,

BLUE,

GREEN;

}

2.        使用

枚举定义完成以后,就可以以“枚举名.枚举项”的形式在代码中对定义的枚举进行使用。在特殊情况下,如果程序能够识别出当前的枚举类型,则只需要给出枚举项即可,例如在switch语句块中的case关键字后的常量值。

以下是一段使用枚举的简单示例代码。

MyColor color0 =  MyColor.RED;

switch(color0)

{

case RED:

System.out.println(“红色”);

break;

case BLUE:

System.out.println(“蓝色”);

break;

case GREEN:

System.out.println(“绿色”);

break;

default:

System.out.println(“未知色”);

break;

}

3.        常规方法

Java枚举提供了几个方法供开发者在需要时调用,对于枚举对象,主要可用的方法为values,它返回当前枚举中定义的所有枚举项的集合;对于枚举项,主要可用的方法有ordinal、name和getDeclaringClass。方法ordinal返回枚举项在枚举对象中的序号;方法name则返回枚举项的名称(与方法toString效果相同),通常用于取得枚举变量中保存的枚举项名称;而方法getDeclaringClass则用于取得当前枚举值所在类的完整名称。

此外,枚举项之间还可以通过方法compareTo进行比较,如果参数传入的枚举项与当前值相等,则返回0。

上述枚举定义及使用的完整例程如下:

packagenet.yanzhijun.example;

 

enumMyColor

{

RED,

BLUE,

GREEN;

}

 

publicclass EnumExample

{

public static void main(String[] args)

{

MyColor color0 =  MyColor.RED;

switch(color0)

{

case RED:

System.out.println(“红色”);

break;

case BLUE:

System.out.println(“蓝色”);

break;

case GREEN:

System.out.println(“绿色”);

break;

default:

System.out.println(“未知色”);

break;

}

for(MyColor myColor: MyColor.values())

{

System.out.println(myColor);

System.out.println(myColor.ordinal());

System.out.println(myColor.name());

System.out.println(myColor.getDeclaringClass());

System.out.println(“============================================”);

}

MyColor color1 = MyColor.valueOf(“RED”);

System.out.println(color1);

System.out.println(color1.ordinal());

System.out.println(color1.name());

System.out.println(color1.getDeclaringClass());

}

}

其运行结果如图 1:

运行结果

图 1

 

二、            为枚举添加构造器和成员方法

1.       构造器

类拥有构造器,枚举是一种特殊的类,所以枚举也可以拥有自己的构造器。但与普通类的不同之处在于枚举的构造器不可以是public的,其原因在于该构造器是提供给枚举对象中的枚举项构造时使用的,它并不需要在枚举对象之外使用。

例如,如果希望枚举MyColor中的每个枚举项包含有相应的中文说明以及其对应的Color信息,则可以为MyColor增加一个包含有两个参数的构造器,并且在声明每一个枚举项时使用这个构造器进行构造。其实现代码如下:

enum MyColor

{

RED(“红色”,Color.RED),

BLUE(“蓝色”,Color.BLUE),

GREEN(“绿色”,Color.GREEN);

private String summy;

private Color color;

private MyColor(Stringsummy, Color color)

{

this.summy = summy;

this.color = color;

}

}

 

2.       成员方法

如同可以为枚举添加构造器一样也可以为枚举添加方法。例如上述代码中通过构造器为每个枚举项添加了中文说明以及其对应的Color信息,那么为了取出枚举项对应的信息,则需要为枚举MyColor添加如下相应方法。

    public String getSummy()

{

return this.summy;

}

public Color getColor()

{

return this.color;

}

可以看到,通过以上机制,可以将枚举本身要表达的含义与其具体的信息很好地整合起来,杜绝了传统编程语言中含义与信息分离的弊端。

枚举构造器、成员方面及完整的测试代码如下:

packagenet.yanzhijun.example;

 

importjava.awt.Color;

 

enumMyColor

{

RED(“红色”, Color.RED),

BLUE(“蓝色”,Color.BLUE),

GREEN(“绿色”,Color.GREEN);

private String summy;

private Color color;

private MyColor(String summy, Color color)

{

this.summy = summy;

this.color = color;

}

public String getSummy()

{

return this.summy;

}

public Color getColor()

{

return this.color;

}

}

 

publicclass EnumExample2

{

public static void main(String[] args)

{

for(MyColor myColor: MyColor.values())

{

System.out.println(myColor);

System.out.println(myColor.getSummy());

System.out.println(myColor.getColor());

System.out.println(“==============================”);

}

MyColor color1 =MyColor.valueOf(“RED”);

System.out.println(color1);

System.out.println(color1.getSummy());

System.out.println(color1.getColor());

}

}

其运行结果如图 2所示。

运行结果

图 2

 

三、            枚举集合

Java中的枚举是一个对象,枚举对象中的各枚举项也是对象。在Java中,集合容器要求存储在其中的每一个成员均是对象类型,而枚举作为一种特殊的类,Java亦专门为枚举提供了集合容器EnumSet和EnumMap。

1.       EnumSet

EnumSet用于保存枚举项的集合,在枚举项本身并不互斥的情况下特别有用。例如,一个应用系统通常会有多种角色,而某些人在系统中可能承担不止一种角色。如果这些角色是通过枚举定义的,则此时EnumSet将可以将多种角色保存在一起,标识特定用户承担的全部角色。

EnumSet扩展于AbstractSet,它除了拥了普通Set所拥有的方法外,主要是增加了一系列可产生EnumSet实例的方法(noneOf、allOf、copyOf、complementOf、of、range等)。

以下是使用EnumSet的of方法产生一个EnumSet实例的示例。

package net.yanzhijun.example;

 

import java.util.EnumSet;

 

enum Role

{

SYSADMIN,

ROLEA,

ROLEC;

}

 

public class EnumSetExample

{

public static voidmain(String[] args)

{

EnumSet<Role> es= EnumSet.of(Role.ROLEA, Role.ROLEB);

for(Role role: es)

{

System.out.println(role);

}

}

}

 

2.       EnumMap

EnumMap是必须使用枚举项作为其KEY的Map,其法与普通Map类似。以下例程将两类角色的中文含义置入到一个EnumMap对象中,并随后调用了EnumMap的size和get方法。

packagenet.yanzhijun.example;

importjava.util.EnumMap;

enum Role

{

SYSADMIN,

ROLEA,

ROLEB,

ROLEC;

}

publicclass EnumMapExample

{

public static void main(String[] args)

{

EnumMap<Role, String> em = newEnumMap<Role, String>(Role.class);

em.put(Role.SYSADMIN, “系统管理员”);

em.put(Role.ROLEA, “角色A”);

System.out.println(em.size());

System.out.println(em.get(Role.SYSADMIN));

}

}

标签