Class enum java valueof

Загадки Enum’ов

Перечисления появились в пятой версии Java и с тех пор крепко обосновались в наших приложениях. Работа с перечислениями почти не отличается от работы с любыми другими классами в Java. Но есть несколько особенностей, которые вызывают удивление. Каждый раз сталкиваясь с ними, хочется спросить: «Почему так?».

Давайте попробуем разобраться.

Порядок инициализации

В отличие от некоторых других языков программирования в Java перечисления являются полноценными классами. Конечно, есть некоторые особенности, например:

• нельзя наследоваться от классов (но можно реализовывать интерфейсы);
• нельзя объявлять класс финальным или абстрактным;
• нельзя создавать конструкторы с модификаторами public или protected ;
• множество других ограничений (полный список можно найти в документации).

Хорошо, смирились с запретами. Но можем ли мы ожидать, что остальные языковые конструкции работают так же, как в остальной Java? Например, порядок инициализации объектов.

Давайте проверим. Для этого напишем такое перечисление:

Остановитесь на секунду и попробуйте предположить что выведется в консоль при обращении к любому из значений перечисления.

В обычных классах при инициализации первого объекта кодовые блоки выполняются в следующем порядке:

Статический блок -> Кодовый блок -> Конструктор 

Для перечисления же мы увидим в консоли следующее:

> Code block > Constructor > Code block > Constructor > Static block

Как же так? Почему статический блок был вызван последним?

Для ответа на этот вопрос давайте прогоним скомпилированный класс через Java Class File Disassembler и вручную переведем дизассемблированный код в java код. Дизассемблинг выполняется командой:

Для самых любопытных привожу результат исполнения команды.

public final class dev.boiarshinov.enumsinjava.initorder.Pine extends java.lang.Enum < public static final dev.boiarshinov.enumsinjava.initorder.Pine FIR; public static final dev.boiarshinov.enumsinjava.initorder.Pine CEDAR; public static dev.boiarshinov.enumsinjava.initorder.Pine[] values(); Code: 0: getstatic #1 // Field $VALUES:[Ldev/boiarshinov/enumsinjava/initorder/Pine; 3: invokevirtual #2 // Method "[Ldev/boiarshinov/enumsinjava/initorder/Pine;".clone:()Ljava/lang/Object; 6: checkcast #3 // class "[Ldev/boiarshinov/enumsinjava/initorder/Pine;" 9: areturn public static dev.boiarshinov.enumsinjava.initorder.Pine valueOf(java.lang.String); Code: 0: ldc #4 // class dev/boiarshinov/enumsinjava/initorder/Pine 2: aload_0 3: invokestatic #5 // Method java/lang/Enum.valueOf:(Ljava/lang/Class;Ljava/lang/String;)Ljava/lang/Enum; 6: checkcast #4 // class dev/boiarshinov/enumsinjava/initorder/Pine 9: areturn static <>; Code: 0: new #4 // class dev/boiarshinov/enumsinjava/initorder/Pine 3: dup 4: ldc #11 // String FIR 6: iconst_0 7: invokespecial #12 // Method "":(Ljava/lang/String;I)V 10: putstatic #13 // Field FIR:Ldev/boiarshinov/enumsinjava/initorder/Pine; 13: new #4 // class dev/boiarshinov/enumsinjava/initorder/Pine 16: dup 17: ldc #14 // String CEDAR 19: iconst_1 20: invokespecial #12 // Method "":(Ljava/lang/String;I)V 23: putstatic #15 // Field CEDAR:Ldev/boiarshinov/enumsinjava/initorder/Pine; 26: iconst_2 27: anewarray #4 // class dev/boiarshinov/enumsinjava/initorder/Pine 30: dup 31: iconst_0 32: getstatic #13 // Field FIR:Ldev/boiarshinov/enumsinjava/initorder/Pine; 35: aastore 36: dup 37: iconst_1 38: getstatic #15 // Field CEDAR:Ldev/boiarshinov/enumsinjava/initorder/Pine; 41: aastore 42: putstatic #1 // Field $VALUES:[Ldev/boiarshinov/enumsinjava/initorder/Pine; 45: getstatic #7 // Field java/lang/System.out:Ljava/io/PrintStream; 48: ldc #16 // String Static block 50: invokevirtual #9 // Method java/io/PrintStream.println:(Ljava/lang/String;)V 53: return >

После ручного перевода в Java код получим следующее (не имеющий отношения к рассматриваемой теме код опущен):

public class PineIsNotEnum extends Enum  < public static final PineIsNotEnum FIR; public static final PineIsNotEnum CEDAR; protected PineIsNotEnum(String name, int ordinal) < super(name, ordinal); System.out.println("Code block"); System.out.println("Constructor"); >static < FIR = new PineIsNotEnum("FIR", 0); CEDAR = new PineIsNotEnum("CEDAR", 1); System.out.println("Static block"); >>

Что же мы видим? Значения перечисления превратились в статические финальные поля. Выражения из кодового блока и конструктора переехали в конструктор. Выражения из статического блока остались в статическом блоке, но до их вызова добавился код создания экземпляров.

Получается, что при первом обращении к классу перечисления первым делом исполняется статический блок. Все как в обычных классах. Первое, что делается в статическом блоке — инициализируются финальные поля класса. Это влечет за собой вызов кода, объявленного в конструкторе, и в консоль дважды выводится

И только после этого исполняется код из статического блока оригинального класса.

Теперь мы знаем в какой класс преобразуется enum при компиляции, и порядок исполнения кодовых блоков становится понятен.
Для того чтобы не держать в памяти последовательность преобразований, приводящую к странному поведению, предлагаю запомнить следующее:

Значения, объявленные в перечислении — это статические финальные поля того же типа, что и класс. Инициализация этих полей происходит в статическом блоке до всех остальных статических выражений.

Отсутствующие методы

Все перечисления неявно унаследованы от абстрактного класса Enum . Если заглянуть в javadoc на этот класс, то можно увидеть следующие методы:

String name() < /* . */ >int ordinal() < /* . */ >Class getDeclaringClass() < /* . */ >int compareTo(E o) < /* . */ >static > T valueOf(Class enumType, String name) < /* . */ >/* Методы класса Object */

Если попробовать в IDE написать любое перечисление, поставить точку и вызвать автодополнение, то он предложит еще два метода:

Pine[] values = Pine.values(); Pine cedar = Pine.valueOf("CEDAR");

В исходниках класса Enum таких методов нет, но они как-то появляются в каждом перечислении.

Чтобы разобраться, обратимся к документации. Из нее мы узнаем, что два этих метода объявлены неявно. Почему неявно? Дело в том, что в отличие от других методов класса Enum эти методы не получается реализовать в абстрактном классе. Метод values() возвращает массив со всеми значениями перечисления, а класс Enum о них ничего не знает. Метод valueOf(String) возвращает конкретное значение перечисления по его названию. Можно было бы в нем вызвать метод valueOf(Class, String) :

public static E valueOf(String name)

Но ничего не выходит из-за того, что класс E невозможно извлечь в статическом контексте.

Почему же нельзя было объявить эти методы абстрактными в Enum , чтобы разработчики могли хотя бы ознакомиться с их контрактом в javadoc? Это невозможно из-за того, что методы не могут быть одновременно статическими и абстрактными. Компилятор не поймет. А методы valueOf(String) и values() по своей природе статические.

Теперь мы понимаем, что данные методы генерируются компилятором. Но какая же у них реализация? В JLS она не приведена, и в исходниках JDK ее тоже не найти.

Здесь нам поможет тот же трюк с дизассемблированием. В первой части статьи я сознательно не стал транслировать дизассемблированный код в Java-код полностью, чтобы не отвлекать внимание от инициализации. Если же пристальнее взглянуть на фрагмент под спойлером, то можно увидеть в дополнение к константам, описывающим значения перечисления, еще одну — VALUES . Она содержит в себе все значения перечисления в виде массива. Массив заполняется сразу после инициализации значений. Этот же массив возвращается при вызове метода values() :

/* . */ private static final PineIsNotEnum[] VALUES; static < FIR = new PineIsNotEnum("FIR", 0); CEDAR = new PineIsNotEnum("CEDAR", 1); VALUES = new PineIsNotEnum[] ; > public static PineIsNotEnum[] values()

Метод valueOf(String) реализуется с помощью вызова тезки:

public static PineIsNotEnum valueOf(String name)

Обобщая знания о неявных методах и порядке инициализации, давайте запишем как может быть представлено перечисление Pine из начала статьи в виде обычного класса:

public class PineIsNotEnum extends Enum  < public static final PineIsNotEnum FIR; public static final PineIsNotEnum CEDAR; private static final PineIsNotEnum[] VALUES; protected PineIsNotEnum(String name, int ordinal) < super(name, ordinal); System.out.println("Code block"); System.out.println("Constructor"); >static < FIR = new PineIsNotEnum("FIR", 0); CEDAR = new PineIsNotEnum("CEDAR", 1); VALUES = new PineIsNotEnum[] ; System.out.println("Static block"); > public static PineIsNotEnum[] values() < return VALUES.clone(); >public static PineIsNotEnum valueOf(String name) < return Enum.valueOf(PineIsNotEnum.class, name); >>

Заключение

Странности в перечислениях вызваны архитектурными решениями и ограничениями, выбранными разработчиками Java. С помощью дизассемблирования нам удалось узнать, как перечисления инициализируются, и как в них реализованы неявные методы.

Надеюсь, что теперь, столкнувшись с необычным поведением перечислений, вы сможете мысленно преобразовать перечисление в обычный класс и разобраться.

Источники

Источник

Class enum java valueof

This is the common base class of all Java language enumeration types. More information about enums, including descriptions of the implicitly declared methods synthesized by the compiler, can be found in section 8.9 of The Java™ Language Specification . Note that when using an enumeration type as the type of a set or as the type of the keys in a map, specialized and efficient set and map implementations are available.

Constructor Summary

Method Summary

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

Methods inherited from class java.lang.Object

Constructor Detail

Enum

Sole constructor. Programmers cannot invoke this constructor. It is for use by code emitted by the compiler in response to enum type declarations.

Method Detail

name

Returns the name of this enum constant, exactly as declared in its enum declaration. Most programmers should use the toString() method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.

ordinal

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures, such as EnumSet and EnumMap .

toString

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn’t necessary or desirable. An enum type should override this method when a more «programmer-friendly» string form exists.

equals

hashCode

public final int hashCode()

clone

protected final Object clone() throws CloneNotSupportedException

Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their «singleton» status.

compareTo

Compares this enum with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Enum constants are only comparable to other enum constants of the same enum type. The natural order implemented by this method is the order in which the constants are declared.

getDeclaringClass

Returns the Class object corresponding to this enum constant’s enum type. Two enum constants e1 and e2 are of the same enum type if and only if e1.getDeclaringClass() == e2.getDeclaringClass(). (The value returned by this method may differ from the one returned by the Object.getClass() method for enum constants with constant-specific class bodies.)

valueOf

public static Enum> T valueOf(Class enumType, String name)

Returns the enum constant of the specified enum type with the specified name. The name must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Note that for a particular enum type T , the implicitly declared public static T valueOf(String) method on that enum may be used instead of this method to map from a name to the corresponding enum constant. All the constants of an enum type can be obtained by calling the implicit public static T[] values() method of that type.

finalize

protected final void finalize()

Источник

Class enum java valueof

* Информация для продвинутых юзеров. На самом деле возможно ограниченное наследование от Enum. Подробнее здесь: https://kibungo.livejournal.com/19999.html Пример наследования и переопределения общего метода:

 public enum MyEnum < VAL1 < public int returnMyVal()< return 20; >>, VAL2; public int returnMyVal() < return 10; >> ------------------------ System.out.println(MyEnum.VAL1.returnMyVal()) // 20 System.out.println(MyEnum.VAL2.returnMyVal()) // 10 

«По сравнению с обычными классами, на Enum наложили одно серьезное ограничение — от него невозможно наследоваться.» Что за бред вы пишете?! Все перечисления изначально неявно расширяют класс java.lang.Enum, а поскольку в Java нету множественного наследования, то и расширять enum уже больше ничего не может.

В статье enum в коде с маленькой буквы, в комментариях к коду — Enum с большой Почему не говорится, что это разные вещи? Если у нас несколько enum`ов с перечислениями в приложении и нам нужно передать один из них как аргумент в метод можно сделать просто так someMethod(Enum e) < и здесь написать условие для выбора одного из enum`ов >Т.е. не нужно приводить все enum`ы к единому интерфейсу или абстрактному классу, чтобы выбрать один из enum`ов Как я понял Enum(тот который с большой буквы) — это что-то типа пустого интерфейса для всех enum`ов

 @Override public String toString() < return "DayOfWeek'; 

В коде приведенного примера про школьника есть ошибка: задано поле private ScholarSchedule schedule, но сеттер для него не прописан, а так как оно изначально не инициализировано, получаете NullPointerException. Добавьте сеттер (либо просто сделайте это поле public, что есть костыль) для задания значения:

 public void setSchedule(ScholarSchedule schedule)

Ну или, в конце концов, поместите метод main в класс Scholar (видимо так и задумывалось автором примера изначально), тогда он будет иметь доступ к private ScholarSchedule schedule и сможет инициализировать его надлежащим образом.

Источник