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

戻り値:

属性カテゴリの名前