Перечисления enum
В простейшей форме перечисление — это список именованных констант. Но в Java перечисления имеют более сложный функционал, чем в других языках программирования. Они могут иметь конструкторы, методы и переменные экземпляра.
Перечисления создаются с использованием ключевого слова enum. Создадим перечисление семейства кошачьих:
enum Cat
Идентификаторы в фигурных скобках называются константами перечисления. Каждый из них явно объявлен как открытый статический финальный член класса Cat. Объявив перечисление, вы можете создавать переменные этого типа. Но делать это нужно без оператора new, а в упрощенном виде. Объявим переменную manul перечислимого типа Cat.
Cat manul;
Вы можете присвоить переменной только те значения, которые определены в перечислении, например:
manul = Cat.Manul;
Обратите внимание, что во время присваивания вы указываете и тип Cat.
Использование перечисляемых переменных позволят избежать ошибок. Например, мы хотим использовать только числа 1, 2, 3 и такой способ не позволит использовать числа 0, 5, 9 и т.д.
Перечислимые константы можно проверить на равенство:
if (manul == Cat.Manul)
Также их можно применять в конструкции switch, где у операторов case используются константы из перечисления enum. При этом имена констант используются без имени типа перечисления.
enum Cat < Leopard, Puma, Lion, Tiger, Manul >public void onClick(View v) < Cat cat; cat = Cat.Manul; String result = ""; switch (cat) < case Leopard: result = "Я леопард"; break; case Puma: result = "Я пума"; break; case Lion: result = "Я царь зверей"; break; case Tiger: result = "Я тигра"; break; case Manul: result = "Погладь кота, . "; break; >textViewInfo.setText(result); >
Метод values()
Автоматически предопределённый метод для перечисления values() возвращает массив, содержащий список констант перечисления.
enum Cat < Leopard, Puma, Lion, Tiger, Manul >public void onClick(View v) < Cat[] allcats = Cat.values(); for(Cat cat : allcats) < System.out.println(cat); >>
Для примера использовалась дополнительная переменная allcats, которой присваивается ссылка на массив перечислимых значений. Можно обойтись без дополнительной переменной.
for(Cat cat : Cat.values())
Метод valueOf(String string)
Автоматически предопределённый метод для перечисления valueOf() возвращает константу перечисления, значение которой соответствует строке, переданной в параметре.
enum Cat < Leopard, Puma, Lion, Tiger, Manul >public void onClick(View v)
Так как перечисление в Java — это тип класса, то вы можете использовать конструкторы, добавлять переменных экземпляров, методы и интерфейсы. Следует сказать, что в Android сначала не рекомендовалось использовать перечисления из-за большого потребления памяти. Сейчас вроде это ограничение сняли, но тем не менее пока перечисления не так широко используются в приложениях для мобильных устройств, поэтому подробно разбирать все возможности перечисления не будем.
Метод ordinal()
У перечислений есть несколько удобных методов. Например, вы можете получить значение, которое указывает позицию константы в списке констант перечисления (порядковое значение или ordinal value), с помощью метода ordinal(). Порядковые значения начинаются с нуля.
for(Cat cat : Cat.values())
Методы compareTo() и equals()
Также можно сравнивать порядковые значения констант одного и того же перечисления с помощью метода compareTo(). Или сравнить на эквивалентность через метод equals().
Увлекаться не стоит из-за большого потребления памяти. Сравним.
// занимает 1112 байт public static enum Things < THING_1, THING_2 >; // другой вариант, занимает 128 байт public static int THING_1 = 0; public static int THING_2 = 1;
По этой причине на сегодняшний день в Android рекомендуется избегать enum. Хотя в последнее время я встречал использование перечислений в исходных кодах Android.
Что такое enum?
enum – тип-перечисление. Бывает много разных формулировок вопроса, все они сводятся к разговору о перечислениях вообще. Технически это финальный класс со статическими финальными полями-экземплярами. enum Foo всегда неявно наследуется от Enum – то есть перечислением нельзя расширить другой класс, но всё еще можно реализовать интерфейсы. Из-за generic-параметра разные перечисления не имеют общего предка кроме Object .
Является Comparable (сравнивается позиция по порядку объявления значений) и Serializable (сериализуется только имя константы).
Имеет только заранее заданный набор значений. Значения неявно public static final и это нельзя переопределить. Для инициализации констант действуют все правила статической инициализации.
Копии элементов перечисления не создаются даже при десериализации. Вот почему Effective Java предлагает использовать для сериализуемого синглтона enum .
Экземпляры хранят свойства name и ordinal – имя и порядковый номер константы. Статический метод values вернет список всех констант, valueOf – константу по имени. Спецификация.
Финализация и клонирование перечислений запрещены.
Перечисления (enums)
Иногда нужно описать ограниченное множество элементов. Встарь это делали посредством целочисленных констант:
public final class HairColourInt < // не позволим никому создавать экземпляры private HairColourInt() <>public static final int BLONDE = 0; public static final int FAIR = 1; public static final int RED = 2; public static final int BROWN = 3; public static final int BLACK = 4; >Минусов у такого подхода несколько:
- Можно, добавляя в новую константу, по ошибке использовать старое числовое значение, например, добавить GREEN = 4 , в то время как BLACK тоже = 4 .
- int приводится к строке как число, это неудобно для отладки.
- В метод, который ожидает на вход значение такой константы, можно передать произвольное число. Например, здесь мы используем числа от нуля до четырёх, но можно передать хоть -1 , хоть 2_000_000_000 .
Enum
enum — это вид класса. У него есть ограниченный набор элементов, и все они доступны статически.
Другие названия: enumerated type, перечисляемый тип, перечисление.
public enum HairColour
Если объявить метод, скажем, findPersonWith(HairColour colour) , то все значения, которые можно передать в метод, ограничиваются следующими: BLONDE , FAIR , RED , BROWN , BLACK и null .
Person redhead = findPersonWith(HairColour.RED);Стандартные методы enum’ов
Все enum’ы являются наследниками класса java.lang.Enum и обладают следующими instance-методами:
name() Имя константы. HairColour.BROWN.name() == «BROWN» ordinal() Порядковый номер. HairColor.BLONDE.ordinal() == 0
Также компилятор генерирует для каждого enum-класса следующие статические методы:
valueOf(String name) Находит константу по имени. HairColour.valueOf(«BROWN») == HairColour.BROWN; HairColour.valueOf(«YELLOW») бросит IllegalArgumentException, т. к. константы с таким именем нет values() Массив допустимых значений. HairColor.values() == [BLONDE, FAIR, RED, BROWN, BLACK]
Стоит учитывать, что, т. к. в Java массивы изменяемы, метод values() каждый раз возвращает новую копию массива (производит защитное копирование). Подробнее об экономии памяти в этой ситуации — в статье «Enum в Java. Маленькая недоработка».
Добавление собственных полей и методов
Очень часто нужно добавить какую-нибудь информацию к элементам enum’а. Это можно сделать так:
public enum HairColour < // Пусть у каждого цвета волос // будет степень яркости. BLONDE(1), FAIR(.8f), RED(.7f), BROWN(.4f), BLACK(0); // Поле для хранения данных. // Должно быть финальным: // недопустимо, чтобы у элемента перечисления // было состояние, т. к. он — константа. private final float brightness; // Конструктор. Он приватный, // изменить это нельзя. HairColour(float brightness) < this.brightness = brightness; >// геттер для поля public float getBrightness() < return brightness; >// Метод для поиска цвета // по уровню яркости. public static HairColour withBrightness(float brightness) < // обходим все возможные значения for (HairColour colour : values()) < // если у очередного цвета // подходящий уровень яркости — возвращаем if (colour.brightness == brightness) < return colour; >> // если нужный цвет не найден — // выбрасываем исключение throw new NoSuchElementException( "There's no HairColour with brightness " + brightness); > >В этом примере HairColour.RED.getBrightness() == .7f , HairColour.withBrightness(0) == HairColour.BLACK , а HairColour.withBrightness(.003f) бросит исключение NoSuchElementException .
Реализация интерфейсов
Enum’ы могут реализовывать интерфейсы.
public enum HairColour implements Runnable < . @Override public void run() < System.out.println("person with " + name().toLowerCase() + " hair runs"); >>HairColour.FAIR.run() выведет person with fair hair runs .
Собственные методы элементов enum’а
Отдельные элементы перечисления могут быть анонимными классами и иметь собственные методы. Например:
public enum HairColour implements Runnable < BLONDE(1), FAIR(.8f), RED(.7f) < // тело анонимного класса @Override public boolean hasSoul() < return false; >>, BROWN(.4f), BLACK(0); . public boolean hasSoul() < return true; >>Таким образом, enum — это не просто набор констант, это почти полноценный класс и очень мощный инструмент.
Перечисления
Программируя, мы часто сталкиваемся с необходимостью ограничить множество допустимых значений для некоторого типа данных. Так, например, день недели может иметь 7 разных значений, месяц в году — 12, а время года — 4. Для решения подобных задач во многих языках программирования со статической типизацией предусмотрен специальный тип данных — перечисление [math](enum)[/math] . Данный тип данных появился в Java начиная с версии 1.5. (enum) предоставляет множество удобств как в компактности записи, так и в удобстве использования. Так же, в отличие, допустим, от C, перечисления в Java представляют собой полноценные объекты, что предоставляет разработчику гораздо большую гибкость.
Введение
Перечисления наследуются от класса [math]java.lang.Enum[/math] , у которого есть ряд удобных методов. Вот одни из них :
[math]— name()[/math] — имя константы в виде строки
[math]— ordinal()[/math] — порядок константы (соответствует порядку, в котором объявлены константы)
[math]— valueOf()[/math] — статический метод, позволяющий получить объект перечисления по классу и имени
Так же, у класса перечисления есть возможность получить все возможные значения перечисления путем вызова метода [math]java.lang.Class.getEnumConstants()[/math] . В классе перечисления имеется возможность задавать конструкторы (только приватные), поля и методы.
Перечисление — это класс
Объявляя enum, мы неявно создаем класс производный от java.lang.Enum. Условно конструкция enum Unit < . >эквивалентна
class Unit extends java.lang.Enum < . >.
И хотя явным образом наследоваться от [math]java.lang.Enum[/math] нам не позволяет компилятор, все же в том, что [math]enum[/math] наследуется, легко убедиться с помощью [math]reflection:[/math]
System.out.println(Unit.class.getSuperclass());
На консоль будет выведено:
class java.lang.Enum
Собственно наследование за нас автоматически выполняет компилятор Java.
Конструкция enum
Начнем с примера. Давайте опишем с помощью enum тип данных для хранения мер длины:
enum Unit
Здесь мы использовали новое ключевое слово enum, присвоили ему имя и указал разрешенные значения. Unit стал перечислимым типом, который вы можете использовать, например, следующим способом:
public class Distance < private double dist; private Unit unit; public Distance(double dist, Unit unit) < this.unit = unit; this.dist = dist; >public void setUnit(Unit unit) < this.unit = unit; >public Unit getUnit() < return unit; >public void setDistance (double dist) < this. dist = dist; >public double getDistance() < return dist; >>
Создав новое перечисление (Unit) предварительно определенного типа, вы можете использовать его аналогично любой другой переменной экземпляра. Естественно, перечислению можно присвоить только одно из перечисленных значений. Обратите внимание также на то, что в getUnit() нет кода проверки ошибок на выход за пределы границ.
Добавление методов в enum
У Вас есть возможность добавлять собственные методы как в enum-класс, так и в его элементы:
enum Unit < KILOMETER(1e3) METER(1) MILLIMETER(1e-3) private final double length; private Unit(double length) < this.length = length >public double getLength() < return length; >>
Обратите внимание что использование конструкторов в enum так же доступно, как и в других классах.
Наследование в enum
С помощью enum в Java можно реализовать иерархию классов, объекты которой создаются в единственном экземпляре и доступны статически. При этом элементы enum могут содержать собственные конструкторы.
enum Unit < KILOMETER < public double getLength() < return 1000; >>, METER < public double getLength() < return 1; >>, MILLIMETER < public double getLength() < return 0.001; >>; public abstract double getLength(); >
Здесь объявляется перечисление Unit с тремя элементами KILOMETER, METER и MILLIMETER. Компилятор создаст следующие классы и объекты:
•Unit - класс производный от java.lang.Enum •KILOMETER - объект 1-го класса производного от Unit •METER - объект 2-го класса производного от Unit •MILLIMETER - объект 3-го класса производного от Unit
Объекты классов KILLOMETER, MILLIMETER и METER существуют в единственном экземпляре и доступны статически. В этом можно убедится:
System.out.println(Unit.class); System.out.println(Unit.KILOMETER.getClass() + " " + Unit.KILOMETER.getClass().getSuperclass()); System.out.println(Unit.METER.getClass() + " " + Unit.METER.getClass().getSuperclass()); System.out.println(Unit.MILLIMETER.getClass() + " " + Unit.MILLIMETER.getClass().getSuperclass());
Результат будет следующим:
class Unit class Unit$1 class Unit class Unit$2 class Unit class Unit$3 class Unit
Использование enum
Итерация по enum
Рассмотрим пример, показывающий, как пройти по значениям любого перечислимого типа.
public void PrintAll (PrintStream out) throws IOException < for (Unit u1 : Unit.values()) < for (Unit u2 : Unit.values()) < out.println(String.format("There are %f %sS in one %s",u2.getLength()/u1.getLength(), u1, u2)); >> >
В результате чего мы получим следующий текст:
There are 1 KILOMETER in one KILIMETER There are 0.001 KILOMETER in one METER There are 0.000001 KILOMETER in one MILLIMETER There are 1000 METER in one KILIMETER There are 1 METER in one METER There are 0.001 METER in one MILLIMETER There are 1000000 MILLIMETER in one KILIMETER There are 1000 MILLIMETER in one METER There are 1 MILLIMETER in one MILLIMETER
Так же можно использовать следующую запись для вывода значений на экран:
System.out.println(Arrays.toString(Unit.values()));
В результате будет выведено:
[KILOMETER, METER, MILLIMETER]
Переключение с enum
Перечислимые типы очень удобно использовать для итерации и в операторах [math]switch[/math] .
Для сравнения значения unit с разными возможными мерами длин можно использовать следующую запись:
unit.equals(Unit.METER)
Но множество сравнений заняло бы много места. Для этого мы используем [math]switch[/math] , в результате чего у нас получается следующая запись:
switch (unit)
В результате чего он выдаст соответствующую меру длины. Так же можно употребить [math]default[/math] , на тот случай, если вдруг другой программист добавил новые значения в Unit, а вас не предупредил. Поставив для варианта [math]default[/math] вывод сообщения об отсутствии в списке значения unit, вы обнаружите это изменение.
Получение элемента enum по строковому представлению его имени
Довольно часто возникает задача получить элемент enum по его строковому представлению. Для этих целей в каждом enum-классе компилятор автоматически создает специальный статический метод: public static EnumClass valueOf(String name), который возвращает элемент перечисления EnumClass с названием, равным name. Пример использования:
String name = "METER"; Unit unit = Unit.valueOf(name);
В результате чего в unit будет записано значение METER.
Коллекции перечислимых типов
В Java использование generics в enum запрещено. Но можно использовать EnumMap и EnumSet.
EnumSet
EnumSet — класс схожий с Set, и созданный для использования в нем элементов Enum классов. Естественно все эллементы находящиеся в EnumSet, должны быть из единственного перечислимого типа, который определяется, явно или неявно, когда набор создается. В EnumSet нулевые элементы не разрешаются, а попытки вставить нулевой элемент бросят Exception. Но, к сожалению, проверки на наличие нулевого элемента будут работать должным образом.
Как и говорилось EnumSet очень схож с обычным Set, поэтому достаточно рассмотреть только примеры инициализации EnumSet:
EnumSet EnumSet.allOf(T.class) - создает EnumSet, содержащий все элементы из указанного класса.
EnumSet EnumSet.copyOf(Collection t) - Создает EnumSet, содержащий все элементы находящиеся в колекции.
EnumSet EnumSet.copyOf(EnumSet s) - Создает EnumSet содержащий те же элементы.
EnumSet EnumSet.complementOf(EnumSet s) - Создает EnumSet с тем же типом данных как и у указанного EnumSet, но содержащий элементы не входящие в указанный набор.
EnumSet EnumSet.noneOf(T.class) - Создает пустой EnumSet, но сразу определяет для него тип используемых в нем данных в последующей работе с ним.
EnumSet EnumSet.of(e1, e2, e3. ) - Создает EnumSet, первоначально содержащий указанные элементы.
EnumSet EnumSet.range(from, to) - Создает EnumSet, первоначально содержащий все элементы в диапазоне от первого указанного элемента до второго указанного элемента.
EnumMap
EnumMap — это специализированный класс Map, для работы с Enum. В EnumMap все происходит аналогично. Все Эллементы должны быть из единственного перечислимого типа. Эллементы так же хранятся в их естественном порядке(порядок в котором хранятся элементы в Enum классе). И Так же не доступен нулевой эллемент, попытки вставить его бросят Exception.
Рассмотрим примеры создания EnumMap :
EnumMap(K.class) - создает пустой EnumMap, и определяет для него тип хранящихся ключей. EnumMap(EnumMap) - создает EnumMap являющийся копией данного. EnumMap(Map) - создает EnumMap, инициализируемую по данной Map.
Пример
Раньше класс бинарных операций мы записывали следующим образом:
public class BinaryOperation < public class Plus < public int calculate (int a, int b)< return a + b; >> public class Minus < public int calculate (int a, int b)< return a - b; >> public class Division < public int calculate (int a, int b)< return a / b; >> public class Times < public int calculate (int a, int b)< return a * b; >> >
С использованием enum все значительно упрощается:
public enum BinaryOperation < Plus("+") < public int calculate(int a, int b)< return a + b; >> Minus("-") < public int calculate(int a, int b)< return a - b; >> Division("/") < public int calculate(int a, int b)< return a / b; >> Times("*") < public int calculate(int a, int b)< return a * b; >> > abstract public int calculate(int a, int b); >