Spec-Zone.ru › OpenJDK 21

Класс EnumSyntax

java.lang.Object
javax.print.attribute.EnumSyntax
Все реализуемые интерфейсы:
Serializable, Cloneable
Прямые известные подклассы:
Chromaticity, ColorSupported, Compression, DialogTypeSelection, Fidelity, Finishings, JobSheets, JobState, JobStateReason, Media, MultipleDocumentHandling, OrientationRequested, PDLOverrideSupported, PresentationDirection, PrinterIsAcceptingJobs, PrinterState, PrinterStateReason, PrintQuality, ReferenceUriSchemesSupported, Severity, SheetCollate, Sides
public abstract class EnumSyntax extends Object implements Serializable, Cloneable
Класс EnumSyntax является абстрактным базовым классом, предоставляющим общее реализацию для всех объектов "типобезопасного перечисления". Класс перечисления (который расширяет класс EnumSyntax) предоставляет группу значений перечисления (объектов), которые являются одиночными экземплярами класса перечисления; например:
     public class Bach extends EnumSyntax {
         public static final Bach JOHANN_SEBASTIAN     = new Bach(0);
         public static final Bach WILHELM_FRIEDEMANN   = new Bach(1);
         public static final Bach CARL_PHILIP_EMMANUEL = new Bach(2);
         public static final Bach JOHANN_CHRISTIAN     = new Bach(3);
         public static final Bach P_D_Q                = new Bach(4);

         private static final String[] stringTable = {
             "Johann Sebastian Bach",
              "Wilhelm Friedemann Bach",
              "Carl Philip Emmanuel Bach",
              "Johann Christian Bach",
              "P.D.Q. Bach"
         };

         protected String[] getStringTable() {
             return stringTable;
         }

         private static final Bach[] enumValueTable = {
             JOHANN_SEBASTIAN,
              WILHELM_FRIEDEMANN,
              CARL_PHILIP_EMMANUEL,
              JOHANN_CHRISTIAN,
              P_D_Q
         };

         protected EnumSyntax[] getEnumValueTable() {
             return enumValueTable;
         }
     }
 
Затем вы можете написать код, который использует операторы == и != для проверки значений перечисления; например:
     Bach theComposer;
     . . .
     if (theComposer == Bach.JOHANN_SEBASTIAN) {
         System.out.println ("The greatest composer of all time!");
     }
 
Метод equals() для класса перечисления просто выполняет проверку на идентичность объектов (==).

Вы можете преобразовать значение перечисления в строку, вызвав toString(). Строка извлекается из таблицы, предоставленной классом перечисления.

Внутри, значение перечисления - это просто целое число, разное целое число для каждого значения перечисления внутри класса перечисления. Вы можете получить целое значение значения перечисления, вызвав getValue(). Целое значение значения перечисления устанавливается при его создании (см. EnumSyntax(int)). Поскольку конструктор защищён, единственно возможными значениями перечисления являются одиночные объекты, объявленные в классе перечисления; дополнительные значения перечисления не могут быть созданы во время выполнения.

Вы можете определить подкласс класса перечисления, который расширяет его дополнительными значениями перечисления. Целые значения значений перечисления подкласса не обязательно должны быть различны от целых значений значений перечисления суперкласса; методы ==, !=, equals(), и toString() всё ещё будут работать правильно, даже если подкласс использует некоторые из тех же целых значений, что и суперкласс. Однако приложение, в котором используется класс перечисления и подкласс, может потребовать различных целых значений в суперклассе и подклассе.

См. также:
  • Сериализованная форма

Краткое описание конструкторов

EnumSyntax(int value)
Модификатор Конструктор Описание
protected
Создать новое значение перечисления с заданным целым значением.

Краткое описание методов

Модификатор и тип Метод Описание
Object clone()
Возвращает копию этого значения перечисления, которая, для сохранения семантики значений перечисления, является тем же объектом, что и это значение перечисления.
protected EnumSyntax[] getEnumValueTable()
Возвращает таблицу значений перечисления для класса перечисления этого значения перечисления.
protected int getOffset()
Возвращает наименьшее целое значение, используемое классом перечисления этого значения перечисления.
protected String[] getStringTable()
Возвращает таблицу строк для класса перечисления этого значения перечисления.
int getValue()
Возвращает целое значение этого значения перечисления.
int hashCode()
Возвращает значение хэш-кода для этого значения перечисления.
protected Object readResolve()
Во время ввода объекта преобразует этот десериализованный экземпляр перечисления в соответствующее значение перечисления, определённое в классе атрибута перечисления.
String toString()
Возвращает строковое значение, соответствующее этому значению перечисления.

Методы, объявленные в классе java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

EnumSyntax

protected EnumSyntax(int value)
Создаёт новое значение перечисления с заданным целым значением.
Параметры:
value - Целое значение

Подробное описание методов

getValue

public int getValue()
Возвращает целое значение этого значения перечисления.
Возвращает:
значение

clone

public Object clone()
Возвращает копию этого значения перечисления, которая, для сохранения семантики значений перечисления, является тем же самым объектом, что и это значение перечисления.
Переопределяет:
clone в классе Object
Возвращает:
копию этого экземпляра.
См. также:
  • Cloneable

hashCode

public int hashCode()
Возвращает значение хэш-кода для этого значения перечисления. Хэш-код — это просто целое значение этого значения перечисления.
Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого объекта.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

toString

public String toString()
Возвращает строковое значение, соответствующее этому значению перечисления.
Переопределяет:
toString в классе Object
Возвращает:
строковое представление объекта.

readResolve

protected Object readResolve() throws ObjectStreamException
Во время ввода объекта преобразует этот десериализованный экземпляр перечисления в надлежащее значение перечисления, определённое в классе атрибута перечисления.
Возвращает:
Значение одиночного объекта перечисления, хранящегося в индексе i-L в таблице значений перечисления, возвращаемой getEnumValueTable(), где i — целое значение этого значения перечисления, а L — значение, возвращаемое getOffset()
Исключения:
ObjectStreamException - если поток не может быть десериализован
InvalidObjectException - если таблица значений перечисления null, целое значение этого значения перечисления не соответствует элементу в таблице значений перечисления или соответствующий элемент в таблице значений перечисления null. (Примечание: InvalidObjectException является подклассом ObjectStreamException, который readResolve() объявлен для выброса.)

getStringTable

protected String[] getStringTable()
Возвращает таблицу строк для класса перечисления этого значения перечисления. Предполагается, что целые значения класса перечисления лежат в диапазоне L..L+N-1, где L — значение, возвращаемое getOffset(), а N — длина таблицы строк. Элемент в таблице строк с индексом i-L — это значение, возвращаемое toString() для значения перечисления, целое значение которого равно i. Если целое число в указанном диапазоне не используется ни одним значением перечисления, оставьте соответствующий элемент таблицы null.

Реализация по умолчанию возвращает null. Если класс перечисления (подкласс класса EnumSyntax) не переопределяет этот метод для возврата non-null таблицы строк, а подкласс не переопределяет метод toString(), метод базового класса toString() вернёт просто строковое представление целого значения этого значения перечисления.

Возвращает:
таблицу строк

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Возвращает таблицу значений перечисления для класса перечисления этого значения перечисления. Предполагается, что целые значения класса перечисления лежат в диапазоне L..L+N-1, где L — значение, возвращаемое getOffset(), а N — длина таблицы значений перечисления. Элемент в таблице значений перечисления с индексом i-L — это объект значения перечисления, целое значение которого равно i; метод readResolve() нужен для сохранения семантики одиночного объекта при десериализации экземпляра перечисления. Если целое число в указанном диапазоне не используется ни одним значением перечисления, оставьте соответствующий элемент таблицы null.

Реализация по умолчанию возвращает null. Если класс перечисления (подкласс класса EnumSyntax) не переопределяет этот метод для возврата non-null таблицы значений перечисления, а подкласс не переопределяет метод readResolve(), метод базового класса readResolve() выбросит исключение при десериализации экземпляра перечисления из потока ввода объекта.

Возвращает:
таблицу значений

getOffset

protected int getOffset()
Возвращает наименьшее целое значение, используемое этим классом перечисления.

Реализация по умолчанию возвращает 0. Если класс перечисления (подкласс класса EnumSyntax) использует целые значения, начинающиеся не с 0, переопределите этот метод в подклассе.

Возвращает:
смещение наименьшего значения перечисления

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/print/attribute/EnumSyntax.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API