java.lang.*中Enum 源代码详解

太过爱你忘了你带给我的痛 2022-12-19 09:18 95阅读 0赞

### java.lang.\*中Enum 源代码详解 ###

*   *  Enum详解
     *  Enum的使用场景
     *  核心方法
     *  final String name()
     *  final int ordinal()
     *  protected Enum(String name, int ordinal)
     *  String toString()
     *  boolean equals(Object other)
     *  final int hashCode()
     *  final int compareTo(E o)
     *  Class getDeclaringClass()
     *  T valueOf(Class enumType,String name)

> 学习Java的同学注意了！！！  
> 学习过程中遇到什么问题或者想获取学习资源的话，欢迎加入Java学习交流群，群号码：543120397 我们一起学Java！

## Enum详解 ##

枚举\[Enum\]是指一个经过排序的、被打包成一个单一实体的项列表。一个枚举的实例，可以使用枚举项列表中任意单一项的值。

## Enum的使用场景 ##

枚举在各个语言当中都有广泛的应用，通常用来表示诸如颜色、方式、类别、状态等等，数量有限、形式离散、表达又极为明确的量。Java从jdk1.5开始，引入了对枚举的支持。

## 核心方法 ##

public abstract class Enum<E extends Enum<E>>
            implements Comparable<E>, Serializable
    final String name() 返回枚举对象在枚举类中的名字
    final int ordinal() 返回枚举对象在枚举类中的序号
    protected Enum(String name, int ordinal) 唯一构造函数
    String toString() 返回枚举对象在枚举类中的名字
    boolean equals(Object other) 比较两个枚举对象是否相等
    final int hashCode() 获取枚举对象的哈希值
    final int compareTo(E o) 比较两个枚举对象的值
    Class<E> getDeclaringClass() 返回与此枚举常量的枚举类型相对应的Class对象
    static <T extends Enum<T>> T valueOf(
    	Class<T> enumType,String name) 返回具有指定名称的指定枚举类型的枚举常量

## final String name() ##

/** * CN("chinese"), * USA("english"); * 返回枚举对象在枚举类中的名字 * 返回结果：CN */
    public final String name() { 
        return name;
    }

## final int ordinal() ##

/** * 返回枚举对象在枚举类中的序号 */
    public final int ordinal() { 
        return ordinal;
    }

## protected Enum(String name, int ordinal) ##

/** * 枚举类唯一构造函数 * 用来初始化枚举对象的name、ordinal的值 */
    protected Enum(String name, int ordinal) { 
        this.name = name;
        this.ordinal = ordinal;
    }

## String toString() ##

/** * 返回枚举对象在枚举类中的名字 */
    public String toString() { 
        return name;
    }

## boolean equals(Object other) ##

/** * 比较两个枚举对象是否相等 */
    public final boolean equals(Object other) { 
        return this==other;
    }

## final int hashCode() ##

/** * 获取枚举对象的哈希值 */
    public final int hashCode() { 
    	//调用父类Object的hashCode方法
        return super.hashCode();
    }

## final int compareTo(E o) ##

/** * 比较两个枚举对象的值 * 如果相等返回0,否则返回ordinal序号的差值 */
    public final int compareTo(E o) { 
    	//首先将o对象强转为Enum对象
        Enum<?> other = (Enum<?>)o;
        //将当前this对象赋值给self
        Enum<E> self = this;
        if (self.getClass() != other.getClass() && // optimization
            self.getDeclaringClass() != other.getDeclaringClass())
            throw new ClassCastException();
        return self.ordinal - other.ordinal;
    }

## Class getDeclaringClass() ##

/** * 返回与此枚举常量的枚举类型相对应的Class对象 */
    public final Class<E> getDeclaringClass() { 
        Class<?> clazz = getClass();
        Class<?> zuper = clazz.getSuperclass();
        return (zuper == Enum.class) ? (Class<E>)clazz : (Class<E>)zuper;
    }

## T valueOf(Class enumType,String name) ##

/** * 根据枚举对象获取枚举类的Class类,指定name从枚举类中获取枚举对象 */
    public static <T extends Enum<T>> T valueOf(Class<T> enumType,String name) { 
    	//获取枚举类对象
        T result = enumType.enumConstantDirectory().get(name);
        if (result != null)
            return result;
        if (name == null)
            throw new NullPointerException("Name is null");
        throw new IllegalArgumentException(
            "No enum constant " + enumType.getCanonicalName() + "." + name);
    }
    
    Map<String, T> enumConstantDirectory() { 
        if (enumConstantDirectory == null) { 
        	//获取所有的枚举类对象
            T[] universe = getEnumConstantsShared();
            if (universe == null)
                throw new IllegalArgumentException(
                    getName() + " is not an enum type");
            Map<String, T> m = new HashMap<>(2 * universe.length);//初始化容量大小为2*元素的length
            //将所有的枚举类对象放入到HashMap中
            for (T constant : universe)
                m.put(((Enum<?>)constant).name(), constant);
            enumConstantDirectory = m;
        }
        return enumConstantDirectory;
    }