Java Enum перечисления с примерами
Enums – это специальный тип, используемый для определения коллекций констант. Точнее, тип перечисления – это особый вид класса Java, который может содержать константы, методы и т. д. Были добавлены в Java 5. Это руководство объясняет, как создавать и использовать их.
Пример Enum
Обратите внимание на ключевое слово enum, которое используется вместо класса или интерфейса. Оно сообщает компилятору, что это определение типа является перечислением.
Вы можете сослаться на константы в перечислении выше, как это:
Обратите внимание, что переменная уровня имеет тип Level, который является типом перечисления, определенным в примере выше. Переменная уровня может принимать одну из констант уровня Level в качестве значения (HIGH, MEDIUM или LOW). В этом случае уровень установлен на HIGH.
В заявлениях if
Поскольку перечисления являются константами, вам часто приходится сравнивать переменную, указывающую на константу перечисления, с возможными константами в типе перечисления:
Level level = . //assign some Level constant to it if( level == Level.HIGH) < >else if( level == Level.MEDIUM) < >else if( level == Level.LOW)
Этот код сравнивает переменную уровня с каждой из возможных констант перечисления в перечислении уровня.
Если одно из значений встречается чаще, чем другие, проверка этого значения в первом операторе if приведет к лучшей производительности, так как выполняется меньше сравнений в среднем. Это не большая разница, если только сравнения не выполняются.
В выражениях
Если ваши типы перечислений содержат много констант, и вам нужно проверить переменную по значениям, как показано в предыдущем разделе, использование оператора переключения switch может быть хорошей идеей:
Level level = . //assign some Level constant to it switch(level)
Замените … на код, который нужно выполнить, если переменная уровня соответствует заданному значению константы уровня. Код может быть простой операцией, вызовом метода и т. д.
Итерации
Вы можете получить массив всех возможных значений типа enum, вызвав его метод static values(). Все типы перечислений получают статический метод values() автоматически компилятором. Вот пример итерации всех значений:
for(Level level : Level.values())
Выполнение этого кода распечатало бы все значения:
Обратите внимание, как распечатываются имена самих констант. Это одна из областей, где перечисления отличаются от статических конечных констант.
toString()
Класс enum автоматически получает метод toString() в классе при компиляции. Он возвращает строковое значение имени данного экземпляра перечисления:
String levelText = Level.HIGH.toString();
Значением переменной levelText после выполнения вышеприведенного оператора будет текст HIGH.
Printing
Если вы печатаете перечисление, вот так:
System.out.println(Level.HIGH);
Затем метод toString() будет вызван и значение, которое будет напечатано, является текстовым именем экземпляра enum. Другими словами, в приведенном выше примере текст HIGH был бы напечатан.
valueOf()
Класс enum автоматически получает статический метод valueOf() в классе при компиляции. Его можно использовать для получения экземпляра класса для данного значения String:
Level level = Level.valueOf("HIGH"); Переменная уровня будет указывать на Level.HIGH после выполнения этой строки.
Fields
Вы можете добавить поля в перечисление. Таким образом, каждое значение константы enum получает их. Значения полей должны быть предоставлены конструктору перечисления при определении констант:
Обратите внимание, что перечисление в приведенном выше примере имеет конструктор, который принимает int. Он устанавливает поле int. Когда постоянные значения перечисления определены, значение int передается в конструктор Java.
Конструктор enum должен быть либо закрытым, либо областью действия пакета (по умолчанию). Вы не можете использовать публичные или защищенные.
Методы
Вы также можете добавлять методы:
public enum Level < HIGH(3), //calls constructor with value 3 MEDIUM(2), //calls constructor with value 2 LOW (1) //calls constructor with value 1 ; // semicolon needed when fields / methods follow private final int levelCode; Level(int levelCode) < this.levelCode = levelCode; >public int getLevelCode() < return this.levelCode; >>
Вы вызываете метод через ссылку на одно из значений констант:
Level level = Level.HIGH; System.out.println(level.getLevelCode());
Этот код выведет значение 3, которое является значением поля levelCode для константы перечисления HIGH.
Вы не ограничены простыми методами получения и установки. Можете создавать методы, которые производят вычисления на основе значений полей константы перечисления. Если поля не объявлены как final, вправе изменить значения полей (хотя это может быть не очень хорошей идеей, учитывая, что перечисления должны быть константами).
Abstract методы
Для класса enum также могут быть абстрактные методы. Если у класса есть абстрактный метод, то каждый экземпляр класса должен его реализовывать:
public enum Level < HIGH< @Override public String asLowerCase() < return HIGH.toString().toLowerCase(); >>, MEDIUM < @Override public String asLowerCase() < return MEDIUM.toString().toLowerCase(); >>, LOW < @Override public String asLowerCase() < return LOW.toString().toLowerCase(); >>; public abstract String asLowerCase(); >
Обратите внимание на объявление абстрактного метода внизу класса enum. Каждый экземпляр enum (каждая константа) определяет собственную реализацию этого метода. Его использование полезно, когда нужна отдельная реализация метода для каждого экземпляра перечисления.
Реализация интерфейса
Enum может реализовать интерфейс, если чувствуете, что это имеет смысл в вашей ситуации:
public enum EnumImplementingInterface implements MyInterface < FIRST("First Value"), SECOND("Second Value"); private String description = null; private EnumImplementingInterface(String desc)< this.description = desc; >@Override public String getDescription() < return this.description; >> Это метод getDescription(), который приходит из интерфейса MyInterface.
Реализация интерфейса с Enum может использоваться для реализации набора различных констант Comparator, которые применяются для сортировки коллекций объектов.
EnumSet
Специальная реализация Java Set под названием EnumSet, которая может хранить перечисления более эффективно, чем стандартные реализации:
EnumSet enumSet = EnumSet.of(Level.HIGH, Level.MEDIUM);
После создания вы можете использовать EnumSet, как и любой другой набор.
EnumMap
Специальная реализация Java Map, которая может использовать экземпляры перечисления в качестве ключей:
EnumMap enumMap = new EnumMap(Level.class); enumMap.put(Level.HIGH , "High level"); enumMap.put(Level.MEDIUM, "Medium level"); enumMap.put(Level.LOW , "Low level"); String levelValue = enumMap.get(Level.HIGH);
Детали
- Перечисления неявно расширяют класс java.lang.Enum, поэтому типы перечислений не могут расширять другой класс.
- Если перечисление содержит поля и методы, определение полей и методов должно всегда идти в списке констант в нем. Кроме того, список констант должен заканчиваться точкой с запятой (;).
Java Enum with Strings
In this guide to Java enum with string values, learn to create enum using strings, iterate over all enum values, get enum value and perform a reverse lookup to find an enum by string parameter.
We should always create enum when we have a fixed set of related constants. Enums are inherently singleton, so they provide better performance.
1. Creating Enum with Strings
Java program to create an enum with strings. The given enum contains deployment environments and their respective URLs. URLs are passed to the enum constructor for each enum constant.
public enum Environment < PROD("https://prod.domain.com:1088/"), SIT("https://sit.domain.com:2019/"), CIT("https://cit.domain.com:8080/"), DEV("https://dev.domain.com:21323/"); private String url; Environment(String envUrl) < this.url = envUrl; >public String getUrl() < return url; >>2. Iterating over Enum Constants
To iterate over enum list, use values() method on enum type which returns all enum constants in an array.
//Get all enums for(Environment env : Environment.values())
PROD :: https://prod.domain.com:1088/ SIT :: https://sit.domain.com:2019/ CIT :: https://cit.domain.com:8080/ DEV :: https://dev.domain.com:21323/To get a single enum value (e.g., get production URL from enum constant), use the getUrl() method that we created.
String prodUrl = Environment.PROD.getUrl(); System.out.println(prodUrl);If we want to get enum constant using its name, then we should use valueOf() method.
Environment sitUrl = Environment.valueOf("SIT"); System.out.println(sitUrl.getUrl());5. Reverse Lookup – Get Enum Name from Value
We will often have the value of enum with us, and we will need to get the enum name by its value. This is achieved using a reverse lookup.
enum Environment < PROD("https://prod.domain.com:1088/"), SIT("https://sit.domain.com:2019/"), CIT("https://cit.domain.com:8080/"), DEV("https://dev.domain.com:21323/"); private String url; Environment(String envUrl) < this.url = envUrl; >public String getUrl() < return url; >//****** Reverse Lookup ************// public static Optional get(String url) < return Arrays.stream(Environment.values()) .filter(env ->env.url.equals(url)) .findFirst(); > >To use the reverse lookup in the application code, use enum.get() method.
String url = "https://sit.domain.com:2019/"; Optional env = Environment.get(url); System.out.println(env.get());