Интерфейс AttributeSet

Все известные подинтерфейсы:
DocAttributeSet, PrintJobAttributeSet, PrintRequestAttributeSet, PrintServiceAttributeSet
Все известные реализующие классы:
HashAttributeSet, HashDocAttributeSet, HashPrintJobAttributeSet, HashPrintRequestAttributeSet, HashPrintServiceAttributeSet
public interface AttributeSet

Интерфейс AttributeSet определяет интерфейс для набора атрибутов печати. Атрибут печати — это объект, класс которого реализует интерфейс Attribute.

Набор атрибутов содержит группу значений атрибутов, где дублируемые значения не допускаются в наборе. Кроме того, каждое значение в наборе атрибутов является членом какой-либо категории, и в наборе разрешено не более одного значения в любой конкретной категории. Для набора атрибутов значения являются объектами Attribute, а категории — объектами Class. Категория атрибута — это класс (или интерфейс) в корне иерархии классов для этого типа атрибута. Обратите внимание, что категория объекта атрибута может быть суперклассом класса объекта атрибута, а не самим классом объекта атрибута. Категория объекта атрибута определяется вызовом метода getCategory(), определенного в интерфейсе Attribute.

Интерфейсы набора AttributeSet похожи на интерфейс java.util.Map API Java Collections, но более ограничены по типам принимаемых значений и объединяют ключи и значения в Attribute.

Наборы атрибутов используются в нескольких местах в API Print Service. В каждом контексте допускаются только определенные виды атрибутов, которые появляются в наборе атрибутов, как определяется интерфейсами разметки, которые реализует класс атрибута — DocAttribute, PrintRequestAttribute, PrintJobAttribute и PrintServiceAttribute. Существуют четыре специализации набора атрибутов, которые ограничены содержанием только одного из четырёх типов атрибутов — DocAttributeSet, PrintRequestAttributeSet, PrintJobAttributeSet и PrintServiceAttributeSet соответственно. Обратите внимание, что многие классы атрибутов реализуют более одного интерфейса разметки и, следовательно, могут появляться более чем в одном контексте.

  • Набор DocAttributeSet, содержащий DocAttribute, определяет характеристики отдельного документа и параметры печати, которые должны применяться к отдельному документу.
  • Набор PrintRequestAttributeSet, содержащий PrintRequestAttribute, определяет параметры, которые должны применяться ко всему заданию печати и ко всем документам в задании печати.
  • Набор PrintJobAttributeSet, содержащий PrintJobAttribute, сообщает о состоянии задания печати.
  • Набор PrintServiceAttributeSet, содержащий PrintServiceAttribute, сообщает о состоянии экземпляра службы печати.
В некоторых контекстах клиенту разрешено только просматривать содержимое набора атрибутов, но не изменять его (набор является только для чтения). В других местах клиенту разрешено как просматривать, так и изменять содержимое набора атрибутов (набор является чтением и записью). Для набора атрибутов только для чтения вызов изменяющей операции вызывает UnmodifiableSetException.

API Print Service предоставляет одно реализацию интерфейса AttributeSet, класс HashAttributeSet. Клиент может использовать класс HashAttributeSet или предоставить собственное реализацию интерфейса AttributeSet. API Print Service также предоставляет реализации подинтерфейсов интерфейса AttributeSet — классы HashDocAttributeSet, HashPrintRequestAttributeSet, HashPrintJobAttributeSet и HashPrintServiceAttributeSet.

Методы

Модификатор и тип Метод Описание
boolean add​(Attribute attribute)

Добавляет указанный атрибут в этот набор атрибутов, если он еще не присутствует, сначала удаляя любое существующее значение в той же категории атрибутов, что и указанное значение атрибута.

boolean addAll​(AttributeSet attributes)

Добавляет все элементы из указанного набора в этот атрибут.

void clear()

Удаляет все атрибуты из этого набора атрибутов.

boolean containsKey​(Class<?> category)

Возвращает true, если этот набор атрибутов содержит атрибут для указанной категории.

boolean containsValue​(Attribute attribute)

Возвращает true, если этот набор атрибутов содержит данное значение атрибута.

boolean equals​(Object object)

Сравнивает указанный объект с этим набором атрибутов для равенства.

Attribute get​(Class<?> category)

Возвращает значение атрибута, которое этот набор атрибутов содержит в данной категории атрибута.

int hashCode()

Возвращает значение хэш-кода для этого набора атрибутов.

boolean isEmpty()

Возвращает true, если этот набор атрибутов не содержит атрибутов.

boolean remove​(Class<?> category)

Удаляет любой атрибут для этой категории из этого набора атрибутов, если он присутствует.

boolean remove​(Attribute attribute)

Удаляет указанный атрибут из этого набора атрибутов, если он присутствует.

int size()

Возвращает количество атрибутов в этом наборе атрибутов.

Attribute[] toArray()

Возвращает массив атрибутов, содержащихся в этом наборе.

Методы

get

Attribute get(Class<?> category)

Возвращает значение атрибута, содержащегося в данном наборе атрибутов в заданной категории атрибутов. Возвращает null , если в данном наборе атрибутов нет значения атрибута в заданной категории атрибутов.

Параметры:
category - категория атрибутов, связанное значение атрибута которой должно быть возвращено. Должен быть Class, реализующий интерфейс Attribute.
Возвращает:
значение атрибута в заданной категории атрибутов, содержащееся в данном наборе атрибутов, или null , если в данном наборе атрибутов нет значения атрибута в заданной категории атрибутов
ИСКЛЮЧЕНИЯ:
NullPointerException - если category является null
ClassCastException - если category не является Class, реализующим интерфейс Attribute

add

boolean add(Attribute attribute)

Добавляет указанный атрибут в этот набор атрибутов, если он еще не присутствует, сначала удалив любое существующее значение в той же категории атрибутов, что и указанное значение атрибута.

Параметры:
attribute - значение атрибута, которое нужно добавить в этот набор атрибутов
Возвращает:
true если этот набор атрибутов изменился в результате вызова, т.е. указанное значение атрибута еще не было членом этого набора атрибутов
ИСКЛЮЧЕНИЯ:
NullPointerException - если attribute является null
UnmodifiableSetException - если этот набор атрибутов не поддерживает операцию add()

remove

boolean remove(Class<?> category)

Удаляет любой атрибут для данной категории из этого набора атрибутов, если он присутствует. Если category является null, то remove() ничего не делает и возвращает false.

Параметры:
category - категория атрибутов, которая должна быть удалена из этого набора атрибутов
Возвращает:
true если этот набор атрибутов изменился в результате вызова, т.е. указанное значение атрибута было членом этого набора атрибутов
ИСКЛЮЧЕНИЯ:
UnmodifiableSetException - если этот набор атрибутов не поддерживает операцию remove()

remove

boolean remove(Attribute attribute)

Удаляет указанный атрибут из этого набора атрибутов, если он присутствует. Если attribute является null, то remove() ничего не делает и возвращает false.

Параметры:
attribute - значение атрибута, которое нужно удалить из этого набора атрибутов
Возвращает:
true если этот набор атрибутов изменился в результате вызова, т.е. указанное значение атрибута было членом этого набора атрибутов
ИСКЛЮЧЕНИЯ:
UnmodifiableSetException - если этот набор атрибутов не поддерживает операцию remove()

containsKey

boolean containsKey(Class<?> category)

Возвращает true , если этот набор атрибутов содержит атрибут для указанной категории.

Параметры:
category - чье присутствие в этом наборе атрибутов нужно проверить
Возвращает:
true если этот набор атрибутов содержит значение атрибута для указанной категории

containsValue

boolean containsValue(Attribute attribute)

Возвращает true , если этот набор атрибутов содержит данное значение атрибута.

Параметры:
attribute - значение атрибута, чье присутствие в этом наборе атрибутов нужно проверить
Возвращает:
true если этот набор атрибутов содержит данное значение атрибута

addAll

boolean addAll(AttributeSet attributes)

Добавляет все элементы из указанного набора в этот набор атрибутов. Результат такой же, как если бы операция = add(Attribute) применялась к этому набору атрибутов последовательно с каждым элементом из указанного набора. Поведение операции addAll(AttributeSet) не определено, если указанный набор изменяется во время выполнения операции.

Если операция addAll(AttributeSet) вызывает исключение, эффект на состояние этого набора атрибутов зависит от реализации; элементы из указанного набора до точки исключения могут или не могут быть добавлены в этот набор атрибутов.

Параметры:
attributes - чьи элементы должны быть добавлены в этот набор атрибутов
Возвращает:
true если этот набор атрибутов изменился в результате вызова
ИСКЛЮЧЕНИЯ:
UnmodifiableSetException - если этот набор атрибутов не поддерживает метод addAll(AttributeSet)
NullPointerException - если какой-либо элемент в указанном наборе является null
См. также:
add(Attribute)

size

int size()

Возвращает количество атрибутов в этом наборе атрибутов. Если этот набор атрибутов содержит более чем Integer.MAX_VALUE элементов, возвращает Integer.MAX_VALUE.

Возвращает:
количество атрибутов в этом наборе атрибутов

toArray

Attribute[] toArray()

Возвращает массив атрибутов, содержащихся в этом наборе.

Возвращает:
содержимое Attributes этого набора в виде массива, нулевой длины, если AttributeSet пуст

clear

void clear()

Удаляет все атрибуты из этого набора атрибутов.

ИСКЛЮЧЕНИЯ:
UnmodifiableSetException - если этот набор атрибутов не поддерживает операцию clear()

isEmpty

boolean isEmpty()

Возвращает true , если этот набор атрибутов не содержит атрибутов.

Возвращает:
true , если этот набор атрибутов не содержит атрибутов

equals

boolean equals(Object object)

Сравнивает указанный объект с этим набором атрибутов на равенство. Возвращает true , если заданный объект также является набором атрибутов и два набора атрибутов содержат те же сопоставления категорий атрибутов-значений атрибутов. Это гарантирует, что метод equals() работает правильно для различных реализаций интерфейса AttributeSet.

Переопределяет:
equals в классе Object
Параметры:
object - для сравнения на равенство с этим набором атрибутов
Возвращает:
true если указанный объект равен этому набору атрибутов
См. также:
Object.hashCode(), HashMap

hashCode

int hashCode()

Возвращает значение хэш-кода для этого набора атрибутов. Хэш-код набора атрибутов определяется как сумма хэш-кодов каждой записи в AttributeSet. Это гарантирует, что t1.equals(t2) подразумевает, что t1.hashCode()==t2.hashCode() для любых двух наборов атрибутов t1 и t2, как требуется общим контрактом Object.hashCode().

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

© 1993, 2020, 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/11/docs/api/java.desktop/javax/print/attribute/AttributeSet.html

Spec-Zone .ru
спецификации, руководства, описания, API