Класс 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()`	Возвращает имя категории, экземпляром которой является это значение атрибута.

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

getLocale, getValue, hashCode, toString

Методы, объявленные в классе 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/print/attribute/standard/DocumentName.html