Класс 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, что подразумевает, что поддержка задания имени документа требует отчёт о 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 — 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
Возвращает:: имя категории атрибута