Интерфейс 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, содержащийDocAttributes, определяет характеристики отдельного документа и параметры печати, применяемые к одному документу. - Набор
PrintRequestAttributeSet, содержащийPrintRequestAttributes, определяет параметры, применяемые к всей работе печати и ко всем документам в этой работе. - Набор
PrintJobAttributeSet, содержащийPrintJobAttributes, сообщает о состоянии работы печати. - Набор
PrintServiceAttributeSet, содержащийPrintServiceAttributes, сообщает о состоянии экземпляра службы печати.
UnmodifiableSetException. API Print Service предоставляет одну реализацию интерфейса AttributeSet, класс HashAttributeSet. Клиент может использовать класс HashAttributeSet или предоставить собственную реализацию интерфейса AttributeSet. API Print Service также предоставляет реализации подинтерфейсов интерфейса AttributeSet, — классы HashDocAttributeSet, HashPrintRequestAttributeSet, HashPrintJobAttributeSet и HashPrintServiceAttributeSet.
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
add |
Добавляет указанный атрибут в этот набор атрибутов, если он еще не присутствует, сначала удаляя любое существующее значение в той же категории атрибутов, что и указанное значение атрибута. |
boolean |
addAll |
Добавляет все элементы в указанный набор в этот атрибут. |
void |
clear() |
Удаляет все атрибуты из этого набора атрибутов. |
boolean |
containsKey |
Возвращает true, если этот набор атрибутов содержит атрибут для указанной категории. |
boolean |
containsValue |
Возвращает true, если этот набор атрибутов содержит указанное значение атрибута. |
boolean |
equals |
Сравнивает указанный объект с этим набором атрибутов на равенство. |
Attribute |
get |
Возвращает значение атрибута, которое этот набор атрибутов содержит в данной категории атрибута. |
int |
hashCode() |
Возвращает хеш-код для этого набора атрибутов. |
boolean |
isEmpty() |
Возвращает true, если этот набор атрибутов не содержит атрибутов. |
boolean |
remove |
Удаляет любой атрибут для этой категории из этого набора атрибутов, если он присутствует. |
boolean |
remove |
Удаляет указанный атрибут из этого набора атрибутов, если он присутствует. |
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 - См. также:
size
int size()
Integer.MAX_VALUE элементов, возвращает Integer.MAX_VALUE.- Возвращает:
- количество атрибутов в данном наборе атрибутов
toArray
Attribute[] toArray()
- Возвращает:
- содержащиеся в этом наборе атрибуты в виде массива, нулевой длины, если набор пуст
clear
void clear()
- Исключения:
-
UnmodifiableSetException- если данный набор атрибутов не поддерживает операциюclear()
isEmpty
boolean isEmpty()
true если данный набор атрибутов не содержит атрибутов.- Возвращает:
-
trueесли данный набор атрибутов не содержит атрибутов
equals
boolean equals(Object object)
true если данный объект также является набором атрибутов и два набора атрибутов содержат те же сопоставления категория-значение атрибутов. Это гарантирует, что метод equals() работает правильно в разных реализациях интерфейса AttributeSet.- Overrides:
-
equalsв классеObject - Параметры:
-
object- для сравнения на равенство с этим набором атрибутов - Возвращает:
-
trueесли указанный объект равен этому набору атрибутов - См. также:
hashCode
int hashCode()
AttributeSet. Это гарантирует, что t1.equals(t2) подразумевает, что t1.hashCode()==t2.hashCode() для любых двух наборов атрибутов t1 и t2, как требуется общим контрактом метода Object.hashCode().- Overrides:
-
hashCodeв классеObject - Возвращает:
- значение хэш-кода для данного набора атрибутов
- См. также:
© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/attribute/AttributeSet.html