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のロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

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

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前