javax.print.attribute.standard

Class DocumentName

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.DocumentName

All Implemented Interfaces:

Serializable ， Cloneable ， Attribute ， DocAttribute

public final class DocumentName
extends TextSyntax
implements DocAttribute

DocumentName类是一个打印属性类，一个指定文档名称的文本属性。 DocumentName是打印数据（文档）的属性，而不是打印作业。 文档的名称是由客户端定义的任意字符串。 但是，如果未指定JobName，则应使用DocumentName，这意味着DocumentName的支持规范需要报告JobName，反之亦然。 见JobName以获取更多信息。

IPP兼容性：字符串值给出IPP名称值。 该地区提供IPP自然语言。 getName()返回的类别名称提供IPP属性名称。

另请参见：

Serialized Form

构造方法摘要

构造方法

Constructor and Description
DocumentName(String documentName, Locale locale) 使用给定的文档名称和语言环境构造新的文档名称属性。

方法摘要

Modifier and Type	Method and Description
boolean	equals(Object object) 返回此文档名称属性是否等同于传入的对象。
类<? extends Attribute>	getCategory() 获取要用作此打印属性值的“类别”的打印属性类。
String	getName() 获取此属性值是一个实例的类别的名称。

Methods inherited from class javax.print.attribute.TextSyntax

getLocale, getValue, hashCode, toString

Methods inherited from class 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为空，则抛出。

方法详细信息

equals

public boolean equals(Object object)

返回此文档名称属性是否等同于传入的对象。 要相等的，所有以下条件必须为真：

1. object不为空。
2. object是DocumentName类的一个实例。
3. 此文档名称属性的底层字符串和object的底层字符串相等。
4. 此文档名称属性的区域设置和object的区域设置相等。

重写：

equals在类别 TextSyntax

参数

object - 要比较的对象。

结果

如果 object相当于此文档名称属性，则为true，否则为false。

另请参见：

Object.hashCode() ， HashMap

getCategory

public final 类<? extends Attribute> getCategory()

获取要用作此打印属性值的“类别”的打印属性类。

对于类DocumentName，类别是DocumentName本身。

Specified by:

getCategory在界面 Attribute

结果

打印属性类（category），一个类别为java.lang.Class的实例。

getName

public final String getName()

获取此属性值是一个实例的类别的名称。

对于DocumentName类，类别名称为"document-name" 。

Specified by:

getName在界面 Attribute

结果

属性类别名称。