javax.print.attribute.standard
クラス PrinterMessageFromOperator

java.lang.Object
  javax.print.attribute.TextSyntax
      javax.print.attribute.standard.PrinterMessageFromOperator

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

Serializable, Cloneable, Attribute, PrintServiceAttribute

public final class PrinterMessageFromOperator
extends TextSyntax
implements PrintServiceAttribute

PrinterMessageFromOperator は、オペレータ、システム管理者、またはインテリジェントプロセスからエンドユーザーに渡される、プリンタ自体またはそのステータスについての情報メッセージを提供する、テキスト属性の印刷属性クラスです。プリンタが利用できない理由、利用できるようになる予定の時期などの情報が提供されます。

印刷サービスの属性セットには、PrinterMessageFromOperator 属性のインスタンスがまったく含まれないか、または 1 つだけ含まれます。 それ以上含まれることはありません。PrinterMessageFromOperator 属性がすでに含まれる場合は、新しい PrinterMessageFromOperator 属性で置き換えられます。つまり PrinterMessageFromOperator には履歴ログ機能はありません。必要があれば印刷サービスの PrinterMessageFromOperator 属性の変更をクライアント側で検出し、PrinterMessageFromOperator 属性値の履歴ログをクライアント側で更新することができます。

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

関連項目:

直列化された形式

コンストラクタの概要

PrinterMessageFromOperator(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

コンストラクタの詳細

PrinterMessageFromOperator

public PrinterMessageFromOperator(String message,
                                  Locale locale)

指定されたメッセージとロケールを使用して、プリンタのオペレータメッセージ属性を新しく構築します。

パラメータ:

message - メッセージ

locale - テキスト文字列の言語。 null の場合、Locale.getDefault() で返される既定のロケールが使用される

例外:

NullPointerException - 未確認の例外。message が null の場合、スローされる

メソッドの詳細

equals

public boolean equals(Object object)

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

1. object が null ではない
2. object が PrinterMessageFromOperator クラスのインスタンスである
3. このプリンタのオペレータメッセージ属性の基底文字列と object の基底文字列が一致する
4. このプリンタのオペレータメッセージ属性のロケールと object のロケールが一致する

オーバーライド:

クラス TextSyntax 内の equals

パラメータ:

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

戻り値:

object がこのプリンタのオペレータメッセージ属性と一致する場合は true、 そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

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

PrinterMessageFromOperator クラスの場合、カテゴリ名は printer-message-from-operator になります。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前