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を生成しなければいけません。プリンタは次のソースのうち、最初に値を生成するものから印刷ジョブの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

戻り値:

属性カテゴリの名前