javax.print.attribute.standard
クラス PrinterStateReasons

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--javax.print.attribute.standard.PrinterStateReasons

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

Attribute, Cloneable, Map, PrintServiceAttribute, Serializable

public final class PrinterStateReasons

extends HashMap

implements PrintServiceAttribute

PrinterStateReasons は、プリンタの現在の状態についての追加情報、つまりプリンタの PrinterState 属性をよりわかりやすくする情報を、値のセットとして列挙する印刷属性クラスです。

PrinterStateReason 自体は印刷サービスの属性セットでは直接使用されず、PrinterStateReasons 属性が使用されます。PriterStateReasons 属性には、印刷サービスのステータスに関連する PrinterStateReason オブジェクトがまったく含まれない場合もあり、1 つ以上含まれる場合もあります。PrinterStateReason オブジェクトは、REPORT (重要度低)、WARNING、または ERROR (重要度高) の Severity レベルにそれぞれ関連付けられます。プリンタは対応する条件が true になった時に PrinterStateReason オブジェクトを印刷サービスの PrinterStateReasons 属性に追加し、false になった時にこのオブジェクトを削除します。印刷サービス全体の PrinterState の変更とは無関係にこの処理が行われます。

PrinterStateReasons クラスは java.util.HashMap クラスの実装を継承します。マップの各エントリは Severity オブジェクト (値) にマッピングされた PrinterStateReason オブジェクト (キー) で構成されます。

一度構築されてしまうと変更されないことが多い通常の印刷属性とは異なり、PrinterStateReasons クラスは変更可能に設計されています。PrinterStateReason オブジェクトを既存の PrinterStateReasons オブジェクトに追加したり、削除したりすることができます。ただし、java.util.HashMap クラスと同じく、PrinterStateReasons クラスもマルチスレッドに対して危険です。PrinterStateReasons オブジェクトがマルチスレッドで使用される場合、確実に操作を同期させてください。たとえば java.util.Collections クラスから取得された同期化マップビューを使って同期させることができます。

IPP 互換性: 各 PrinterStateReason オブジェクトと関連付けられた Severity オブジェクトの toString() メソッドで返される文字列をハイフン (-) でつないだものが IPP キーワード値、getName() で返されるカテゴリ名が IPP 属性名にそれぞれ対応します。

関連項目:

直列化された形式

入れ子クラスの概要

クラス java.util.Map から継承した入れ子クラス

Map.Entry

コンストラクタの概要

PrinterStateReasons()
空のプリンタ状態理由属性を新しく構築します。

PrinterStateReasons(int initialCapacity)
空のプリンタ状態理由属性を新しく構築します。

PrinterStateReasons(int initialCapacity, float loadFactor)
空のプリンタ状態理由属性を新しく構築します。

PrinterStateReasons(Map map)
指定されたマップと同じ PrinterStateReason から Severity へのマッピングを持つプリンタ状態理由属性を新しく構築します。

メソッドの概要

Class	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
String	getName() この属性値がインスタンスであるカテゴリの名称を返します。
Set	printerStateReasonSet(Severity severity) この PrinterStateReasons 属性の指定された重要度レベルの各プリンタ状態属性から、変更不可能なセットビューを返します。
Object	put(Object reason, Object severity) 指定されたプリンタ状態理由をこのプリンタ状態理由属性に追加し、同時に指定された重要度レベルに関連付けます。

クラス java.util.HashMap から継承したメソッド

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values

クラス java.util.AbstractMap から継承したメソッド

equals, hashCode, toString

クラス java.lang.Object から継承したメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェース java.util.Map から継承したメソッド

equals, hashCode

コンストラクタの詳細

PrinterStateReasons

public PrinterStateReasons()

空のプリンタ状態理由属性を新しく構築します。基本となるハッシュマップは既定の初期容量と負荷係数を持ちます。

PrinterStateReasons

public PrinterStateReasons(int initialCapacity)

空のプリンタ状態理由属性を新しく構築します。基本となるハッシュマップは指定された初期容量と既定の負荷係数を持ちます。

パラメータ:

initialCapacity - 初期容量

例外:

IllegalArgumentException - 初期容量がゼロより小さい場合

PrinterStateReasons

public PrinterStateReasons(int initialCapacity,
                           float loadFactor)

空のプリンタ状態理由属性を新しく構築します。基本となるハッシュマップは指定された初期容量と負荷係数を持ちます。

パラメータ:

initialCapacity - 初期容量

loadFactor - 負荷係数

例外:

IllegalArgumentException - 初期容量がゼロより小さい場合

PrinterStateReasons

public PrinterStateReasons(Map map)

指定されたマップと同じ PrinterStateReason から Severity へのマッピングを持つプリンタ状態理由属性を新しく構築します。基本となるハッシュマップの初期容量と負荷係数はスーパークラスのコンストラクタ HashMap(Map) で指定されます。

パラメータ:

map - コピー元のマップ

例外:

NullPointerException - 未確認の例外。map が null の場合、または map に null のキーまたは値が含まれる場合

ClassCastException - 未確認の例外。map のキーに PrinterStateReason クラスのインスタンスでないものが含まれる場合、または map の値に Severity クラスのインスタンスでないものが含まれる場合

メソッドの詳細

put

public Object put(Object reason,
                  Object severity)

指定されたプリンタ状態理由をこのプリンタ状態理由属性に追加し、同時に指定された重要度レベルに関連付けます。このプリンタ状態理由属性に、指定されたプリンタ状態理由のマッピングが登録済の場合、その値が変更されます。

定義:

インタフェース Map 内の put

オーバーライド:

クラス HashMap 内の put

パラメータ:

reason - プリンタ状態理由。PrinterStateReason クラスのインスタンスである必要がある

severity - プリンタ状態理由の重要度。Severityクラスのインスタンスである必要がある

戻り値:

指定されたプリンタ状態理由にこれまで関連付けられていた重要度。指定されたプリンタ状態理由が登録されていなかった場合は null

例外:

NullPointerException - 未確認の例外。reason または severity が null の場合

ClassCastException - 未確認の例外。reason が PrinterStateReason クラスのインスタンスでない場合、または severity が Severity クラスのインスタンスでない場合

getCategory

public final Class getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

この属性値がインスタンスであるカテゴリの名称を返します。

PrinterStateReasons クラスの場合、カテゴリ名は printer-state-reasons になります。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリ名

printerStateReasonSet

public Set printerStateReasonSet(Severity severity)

この PrinterStateReasons 属性の指定された重要度レベルの各プリンタ状態属性から、変更不可能なセットビューを返します。セットビューの各要素は PrinterStateReason オブジェクトです。セットビューに含まれる要素は、指定された重要度の値にマップされた PrinterStateReason オブジェクトだけです。セットビューはこの PrinterStateReasons 属性によって返され、この PrinterStateReasons 属性に対する変更がセットビューに反映されています。セットビューは要素の追加または削除をサポートしません。セットビューの反復子は要素の削除をサポートしません。

パラメータ:

severity - 重要度レベル

戻り値:

指定された Severity レベルの、各 PrinterStateReason 属性のセットビュー

例外:

NullPointerException - 未確認の例外。severity が null の場合