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 のロケールが等しい

オーバーライド:

クラス TextSyntax 内の equals

パラメータ:

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

戻り値:

属性カテゴリの名前