java enum(枚举)使用总结

  enum 的全称为 enumeration， 是 JDK 1.5  中引入的新特性，存放在 java.lang 包中。

    下面是我在使用 enum 过程中的一些经验和总结，主要包括如下内容：

原始的接口定义常量

public interface IConstants  {
	String MON = "Mon";
	String TUE = "Tue";
	String WED = "Wed";
	String THU = "Thu";
	String FRI = "Fri";
	String SAT = "Sat";
	String SUN = "Sun";
}

语法（定义）

/**
 * 测试枚举类
 * @author HuangSir
 */
public enum EnumTest {
	MON, TUE, WED, THU, FRI, SAT, SUN;
}

这段代码实际上调用了7次

Enum(String name, int ordinal)：
new Enum<EnumTest>("MON",0);
new Enum<EnumTest>("TUE",1);
new Enum<EnumTest>("WED",2);
…………

遍历、switch 等常用操作

对enum进行遍历和switch的操作示例代码：

public class Test {
	public static void main(String[] args) {
		for(EnumTest e : EnumTest.values()) {
			System.out.println(e.toString());
		}
		System.out.println("-----我是分隔线-----------");
		EnumTest test = EnumTest.TUE;
		switch(test) {
		case MON:
			System.out.println("今天是星期一");
			break;
		case TUE:
			System.out.println("今天是星期二");
			break;
			// ... ...
		default:
			System.out.println(test);
		break;
		}
	}
}

输出结果：

MON

TUE

WED

THU

FRI

SAT

SUN

----------------我是分隔线------------------

今天是星期二

 

enum 对象的常用方法介绍

int compareTo(E o) 
          比较此枚举与指定对象的顺序。

Class<E> getDeclaringClass() 
          返回与此枚举常量的枚举类型相对应的 Class 对象。

String name() 
          返回此枚举常量的名称，在其枚举声明中对其进行声明。

int ordinal() 
          返回枚举常量的序数（它在枚举声明中的位置，其中初始常量序数为零）。

String toString()

           返回枚举常量的名称，它包含在声明中。

static <T extends Enum<T>> T valueOf(Class<T> enumType, String name) 
          返回带指定名称的指定枚举类型的枚举常量。

public class TestDemo {
	public static void main(String[] args) {
		EnumTest test = EnumTest.TUE;
		//compareTo(E o)
		switch (test.compareTo(EnumTest.MON)) {
		case -1:
			System.out.println("TUE 在 MON 之前");
			break;
		case 1:
			System.out.println("TUE 在 MON 之后");
			break;
			default:
				System.out.println("TUE 与 MON 在同一位置");
				break;
		}
		//getDeclaringClass()
		System.out.println("getDeclaringClass(): " + test.getDeclaringClass().getName());
		//name() 和  toString()
		System.out.println("name(): " + test.name());
		System.out.println("toString(): " + test.toString());
		//ordinal()， 返回值是从 0 开始
		System.out.println("ordinal(): " + test.ordinal());
	}
}

输出结果：

TUE 在 MON 之后

getDeclaringClass(): cn.titcast.EnumTest

name(): TUE

toString(): TUE

ordinal(): 1

 

给 enum 自定义属性和方法

给 enum 对象加一下 value 的属性和 getValue() 的方法：

/**
 * 测试枚举类
 * @author HuangSir
 */
public enum EnumTest1 {
	MON(1), TUE(2), WED(3), THU(4), FRI(5), SAT(6){
		@Override
		public boolean isRest() {
			return false;
		}
	}, SUN(0){
		@Override
		public boolean isRest() {
			return true;
		}
	};
	private int value;
	public int getValue() {
		return value;
	}
	public boolean isRest() {
		return false;
	}
	public void setValue(int value) {
		this.value = value;
	}
	private EnumTest1(int value){
		this.value = value;
	}
}

public class Demo {
	public static void main(String[] args) {
		System.out.println(EnumTest1.SUN.isRest());
		System.out.println(EnumTest1.MON.isRest());
	}
}

输出结果：

true

false

 

EnumSet，EnumMap 的应用

public class Demo {
	public static void main(String[] args) {
		EnumSet<EnumTest> weekSet = EnumSet.allOf(EnumTest.class);
		for (EnumTest day : weekSet) {
			//System.out.println(day);
		}
		EnumMap<EnumTest, String> weekMap = new EnumMap(EnumTest.class);
		weekMap.put(EnumTest.MON, "星期一");
		weekMap.put(EnumTest.TUE, "星期二");
		System.out.println(weekMap.size());
		//--------- 
		for (Iterator<Entry<EnumTest, String>> iter = weekMap.entrySet().iterator(); iter.hasNext();) {
			Entry<EnumTest, String> entry = iter.next();
			EnumTest test = entry.getKey();
			System.out.println(test.ordinal() + ":"+test.name() + ":"+ entry.getValue());
		}
	}
}

结果：

2

MON:星期一

TUE:星期二

 

项目实践

public enum Status {
	ts("天山",1),
	em("峨眉",2),
	wd("武当",3),
	sl("少林",4);
	private String name;
	private int index;	
	private Status(String name,int index){
		this.name = name;
		this.index = index;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getIndex() {
		return index;
	}
	public void setIndex(int index) {
		this.index = index;
	}
	public static String getName(int index){
		for (Status temp : Status.values()) {
			if(temp.getIndex()==index){
				return temp.getName();
			}
		}
		return null;
	}
	public static String getType(int index){
		for (Status temp : Status.values()) {
			if(temp.getIndex()==index){
				return temp.name();
			}
		}
		return null;
	}
}
public static void main(String[] args) {
		int i = Status.cnl.getIndex();
		String s1 = Status.getName(i);
		String s2 = Status.getType(i);
		System.out.println(i+"--"+s1+"--"+s2);
}

结果：

1--天山--ts

原理分析

enum 的语法结构尽管和 class 的语法不一样，但是经过编译器编译之后产生的是一个class文件。该class文件经过反编译可以看到实际上是生成了一个类，该类继承了java.lang.Enum<E>。EnumTest 经过反编译(javap com.hmw.test.EnumTest 命令)之后得到的内容如下：

public class com.hmw.test.EnumTest extends java.lang.Enum{
    public static final com.hmw.test.EnumTest MON;
    public static final com.hmw.test.EnumTest TUE;
    public static final com.hmw.test.EnumTest WED;
    public static final com.hmw.test.EnumTest THU;
    public static final com.hmw.test.EnumTest FRI;
    public static final com.hmw.test.EnumTest SAT;
    public static final com.hmw.test.EnumTest SUN;
    static {};
    public int getValue();
    public boolean isRest();
    public static com.hmw.test.EnumTest[] values();
    public static com.hmw.test.EnumTest valueOf(java.lang.String);
com.hmw.test.EnumTest(java.lang.String, int, int, com.hmw.test.EnumTest);
}

总结

    可以把 enum 看成是一个普通的 class，它们都可以定义一些属性和方法，不同之处是：enum 不能使用 extends 关键字继承其他类，因为 enum 已经继承了 java.lang.Enum（java是单一继承）。