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互換性: 文字列の値は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のロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

object - 比較対象のオブジェクト。

戻り値:

objectがこのドキュメントの名前属性と等しい場合はtrue、そうでない場合は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

戻り値:

属性カテゴリの名前