Класс 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)` Возвращает, эквивалентен ли данный атрибут имени документа переданному объекту.
`Class<? extends Attribute>`	`getCategory()` Получить класс атрибута печати, который должен использоваться в качестве "категории" для этого значения атрибута печати.
`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 - Объект для сравнения.
Возвращает:: True, если object эквивалентен данному атрибуту имени документа, иначе false.
См. также:: Object.hashCode(), HashMap

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, 2020, 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.