javax.print.attribute.standard
類別 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 是列印資料（文檔）的屬性，而不是 Print Job 的屬性。文檔名稱是客戶機所定義的任意字元串。但是，如果未指定 JobName，則應使用 DocumentName 替代，這意味著 DocumentName 支持規範要求 JobName 的報告，反之亦然。有關更多資訊，請參閱 JobName。

IPP Compatibility: 字元串值給出了 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)

返回此文檔名稱屬性是否等效於傳入的物件。若要等效，以下所有條件都必須為 true：

1. object 不為 null。
2. object 為 DocumentName 類別的實例。
3. 此文檔名稱屬性的底層字元串與 object 的底層字元串相同。
4. 此文檔名稱屬性的語言環境與 object 的語言環境相同。

覆寫：

類別 TextSyntax 中的 equals

參數：

object - 要比較的 Object。

返回：

如果 object 等效於此文檔名稱屬性，則返回 true，否則返回 false。

另請參見：

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

獲取將被用作此列印屬性值的“類別別”的列印屬性類別。

對於 DocumentName 類別，類別別為 DocumentName 類別本身。

指定者：

介面 Attribute 中的 getCategory

返回：

列印屬性類別（類別別），它是 java.lang.Class 類別的實例。

getName

public final String getName()

獲取類別別名稱，這裡此屬性值是該類別別的實例。

對於 DocumentName 類別，類別別名稱為 "document-name"。

指定者：

介面 Attribute 中的 getName

返回：

屬性類別別名稱。