Класс DocumentName

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.DocumentName

Все реализуемые интерфейсы:: Serializable, Cloneable, Attribute, DocAttribute

public final class DocumentName extends TextSyntax implements DocAttribute

Класс DocumentName — это класс атрибута печати, текстовый атрибут, определяющий имя документа. DocumentName — это атрибут данных печати (документа), а не задания печати. Имя документа — это произвольная строка, определяемая клиентом. Однако если имя задания (JobName) не указано, то следует использовать DocumentName, что подразумевает, что поддержка указания DocumentName требует отчёт об имени задания (JobName), и наоборот. См. JobName для получения дополнительной информации.

Совместимость с IPP: Строковое значение задаёт значение имени в IPP. Локаль задаёт естественный язык IPP. Имя категории, возвращаемое getName(), задаёт имя атрибута в IPP.

См. также:

Сериализованная форма

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

Конструктор	Описание
`DocumentName(String documentName, Locale locale)`	Создаёт новый атрибут имени документа с заданным именем документа и локалью.

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

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object object)`	Возвращает, эквивалентен ли этот атрибут имени документа переданному объекту.
`final Class<? extends Attribute>`	`getCategory()`	Получает класс атрибута печати, который должен использоваться в качестве "категории" для этого значения атрибута печати.
`final String`	`getName()`	Получает имя категории, экземпляром которой является это значение атрибута.

Методы, объявленные в классе javax.print.attribute.TextSyntax

getLocale, getValue, hashCode, toString

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

DocumentName

public DocumentName(String documentName, Locale locale)

Создаёт новый атрибут имени документа с заданным именем документа и локалью.

Параметры:: documentName - имя документа; locale - естественный язык текстовой строки. null интерпретируется как локаль по умолчанию, возвращаемая Locale.getDefault()
Исключения:: NullPointerException - если documentName равно null

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

equals

public boolean equals(Object object)

Возвращает, эквивалентен ли этот атрибут имени документа переданному объекту. Для эквивалентности должны выполняться все следующие условия:

object не равно null.
object является экземпляром класса DocumentName.
Строка, лежащая в основе этого атрибута имени документа, и строка, лежащая в основе object, равны.
Локаль этого атрибута имени документа и локаль object равны.

Переопределяет:

equals в классе TextSyntax

Параметры:

object - Object для сравнения

Возвращает:

true если object эквивалентен этому атрибуту имени документа, false в противном случае

См. также:

getCategory

public final Class<? extends Attribute> getCategory()

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

Для класса DocumentName, категорией является сам класс DocumentName.

Определено в:: getCategory в интерфейсе Attribute
Возвращает:: класс атрибута печати (категория), экземпляр класса java.lang.Class

getName

public final String getName()

Получает имя категории, экземпляром которой является это значение атрибута.

Для класса DocumentName, имя категории равно "document-name".

Определено в:: getName в интерфейсе Attribute
Возвращает:: имя категории атрибута

© 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/standard/DocumentName.html