javax.print.attribute.standard

クラスJobMessageFromOperator

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.JobMessageFromOperator

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

Serializable, Cloneable, Attribute, PrintJobAttribute

public final class JobMessageFromOperator
extends TextSyntax
implements PrintJobAttribute

JobMessageFromOperatorクラスは、オペレータ、システム管理者、またはインテリジェント・プロセスからエンド・ユーザーに渡される、ジョブに対してとられた変更などの管理アクションの理由を示すメッセージを提供する、テキスト属性の印刷属性クラスです。

Print Jobの属性セットは、インスタンスを持たないか、またはJobMessageFromOperator属性の1インスタンスを持ちます。ただし、複数のインスタンスは持ちません。新しいJobMessageFromOperator属性は、既存のJobMessageFromOperator属性がある場合はそれを置き換えます。言い換えると、JobMessageFromOperatorはログ履歴となるものではありません。ログ履歴とする場合、クライアントはPrint JobのJobMessageFromOperator属性の変更を検出して、JobMessageFromOperator属性の値のクライアント自身のログ履歴を保存します。

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

関連項目:

直列化された形式

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

コンストラクタ

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

コンストラクタの詳細

JobMessageFromOperator

public JobMessageFromOperator(String message,
                              Locale locale)

指定されたメッセージとロケールを使用して、新しいオペレータからのジョブ・メッセージ属性を作成します。

パラメータ:

message - メッセージ。

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

例外:

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

メソッドの詳細

equals

public boolean equals(Object object)

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

1. objectがnullではない。
2. objectがJobMessageFromOperatorクラスのインスタンスである。
3. このオペレータからのジョブ・メッセージ属性の基になる文字列とobjectの基になる文字列が同じである。
4. このオペレータからのジョブ・メッセージ属性のロケールとobjectのロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

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

戻り値:

objectがこのオペレータからのジョブ・メッセージ属性と等しい場合はtrue、そうでない場合はfalse。

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

JobMessageFromOperatorクラスの場合、カテゴリ名は"job-message-from-operator"です。

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前