Класс 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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/print/attribute/standard/DocumentName.html