javax.print.attribute.standard

クラス JobName

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.JobName

すべての実装されたインタフェース:

Serializable, Cloneable, Attribute, PrintJobAttribute, PrintRequestAttribute

public final class JobName
extends TextSyntax
implements PrintRequestAttribute, PrintJobAttribute

JobName クラスは、印刷ジョブの名前を指定するテキスト属性の印刷属性クラスです。ジョブの名前はクライアントによって定義される任意の文字列です。これは異なるジョブの間で一意である必要はありません。Print Job の JobName 属性は、Print Request の属性セットでクライアントが提供する値に設定されます。ただし、クライアントが Print Request で JobName 属性を提供しない場合、プリンタは Print Job を作成するときに JobName を生成しなければいけません。プリンタは、値を生成する次のソースの最初のソースから Print Job の JobName 属性の値を生成する必要があります。(1) ジョブの最初のドキュメントまたは唯一のドキュメントの DocumentName 属性、(2) ドキュメントの印刷データの表現オブジェクトが URL の場合、ジョブの最初のドキュメントまたは唯一のドキュメントの URL、または (3) その他印刷ジョブ固有の情報またはドキュメントの内容情報、あるいはその両方。

IPP 互換性: 文字列の値は IPP 名の値を示します。ロケールは IPP の言語を示します。getName() によって返されるカテゴリ名は IPP 属性の名前を示します。

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
JobName(String jobName, 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

コンストラクタの詳細

JobName

public JobName(String jobName,
       Locale locale)

指定されたジョブの名前とロケールで、新しいジョブ名属性を構築します。

パラメータ:

jobName - ジョブ名。

locale - テキスト文字列の言語。null は、Locale.getDefault() によって返されるデフォルトのロケールを示すと解釈されます

例外:

NullPointerException - 非チェック例外。jobName が null の場合にスローされます。

メソッドの詳細

equals

public boolean equals(Object object)

このジョブ名属性がオブジェクトに渡された属性と等しいかどうかを返します。次の条件がすべて true の場合に同等とみなされます。

1. object が null ではない。
2. object が JobName クラスのインスタンスである。
3. このジョブ名属性の基になる文字列と object の基になる文字列が同じである。
4. このジョブ名属性のロケールと object のロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

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

戻り値:

object がこのジョブ名属性と等しい場合は true、そうでない場合は false。

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

JobName クラスの場合、カテゴリは JobName クラス自体です。

定義:

getCategory、インタフェース: Attribute

戻り値:

印刷属性クラス (カテゴリ)、java.lang.Class クラスのインスタンス。

getName

public final String getName()

属性値がインスタンスとなるカテゴリの名前を返します。

JobName クラスの場合、カテゴリ名は "job-name" です。

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前