Класс 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

Модификатор и тип	Метод	Описание
`Locale`	`getLocale()`	Возвращает естественный язык (локаль) текстовой строки этого текстового атрибута.
`String`	`getValue()`	Возвращает текстовую строку этого текстового атрибута.
`int`	`hashCode()`	Возвращает хеш-код этого текстового атрибута.
`String`	`toString()`	Возвращает `String`, идентифицирующий этот текстовый атрибут.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`protected void`	`finalize()`	Устарело, предназначено для удаления: этот элемент API может быть удален в будущей версии. Финализация устарела и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать до пробуждения, обычно вследствие вызова notify или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать до пробуждения, обычно вследствие вызова notify или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать до пробуждения, обычно вследствие вызова notify или прерывания, либо до истечения заданного промежутка реального времени.

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

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.