モジュール java.desktop
パッケージ javax.print.attribute.standard

クラスPrinterStateReasons

  • すべての実装されたインタフェース:
    Serializable, Cloneable, Map<PrinterStateReason,Severity>, Attribute, PrintServiceAttribute
    public final class PrinterStateReasons
extends HashMap<PrinterStateReason,Severity>
implements PrintServiceAttribute
    クラスPrinterStateReasonsは、プリンタの現在の状態に関する追加情報、つまりプリンタPrinterState属性の値を増やす情報を提供する一連の列挙値である印刷属性クラスです。

    PrinterStateReasonのインスタンスは印刷ジョブの属性セットでは直接使用されません。 PrinterStateReasons属性が使用されます。 PrinterStateReasons属性には、印刷サービスのステータスに関する0,1、または複数のPrinterStateReasonオブジェクトが含まれ、各PrinterStateReasonオブジェクトは、REPORT (最も厳しい)、WARNING、またはERROR (最も厳しい)のSeverityレベルに関連付けられています。 プリンタは対応する条件がtrueになったときにPrinterStateReasonオブジェクトを印刷サービスのPrinterStateReasons属性に追加し、falseになったときにPrinterStateReasonオブジェクトを削除します。印刷サービス全体の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属性の名前を示します。

    関連項目:
    直列化された形式

    • コンストラクタの詳細

      • PrinterStateReasons

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

      • PrinterStateReasons

        public PrinterStateReasons​(int initialCapacity)
        新しい空のプリンタ状態理由属性を作成します。基本となるハッシュ・マップには、指定された初期容量とデフォルトの負荷係数があります。
        パラメータ:
        initialCapacity - 初期容量
        例外:
        IllegalArgumentException - 初期容量が負の場合

      • PrinterStateReasons

        public PrinterStateReasons​(int initialCapacity,
                           float loadFactor)
        空のプリンタ状態理由属性を新しく構築します。基本となるハッシュ・マップは指定された初期容量と負荷係数を持ちます。
        パラメータ:
        initialCapacity - 初期容量
        loadFactor - 負荷率
        例外:
        IllegalArgumentException - 初期容量が負の場合

      • PrinterStateReasons

        public PrinterStateReasons​(Map<PrinterStateReason,Severity> map)
        指定されたマップと同じPrinterStateReasonからSeverityへのマッピングを持つプリンタ状態理由属性を新しく構築します。 基本となるハッシュ・マップの初期容量と負荷係数はスーパー・クラスのコンストラクタHashMap(Map)で指定されます。
        パラメータ:
        map - マップをコピー
        例外:
        NullPointerException - mapがnullの場合、またはmapの任意のキーまたは値がnullの場合
        ClassCastException - mapのいずれかのキーがPrinterStateReasonクラスのインスタンスでない場合、またはmapの値がSeverityクラスのインスタンスでない場合

    • メソッドの詳細

      • put

        public Severity put​(PrinterStateReason reason,
                    Severity severity)
        指定されたプリンタ状態理由をこのプリンタ状態理由属性に追加し、同時に指定された重要度レベルに関連付けます。 このプリンタ状態理由属性に、指定されたプリンタ状態理由のマッピングが登録済の場合、その値が変更されます。
        定義:
        put、インタフェース: Map<PrinterStateReason,Severity>
        オーバーライド:
        put、クラス: HashMap<PrinterStateReason,Severity>
        パラメータ:
        reason - プリンタ状態の理由。 これは、PrinterStateReasonクラスのインスタンスである必要があります
        severity - プリンタの状態理由の重大度。 これは、Severityクラスのインスタンスである必要があります
        戻り値:
        指定されたプリンタ状態理由に関連する以前の重大度、または指定されたプリンタ状態理由が存在しない場合はnull
        例外:
        NullPointerException - reasonがnullまたはseverityがnullの場合
        ClassCastException - reasonがPrinterStateReasonクラスのインスタンスでない場合、またはseverityがSeverityクラスのインスタンスでない場合
        導入されたバージョン:
        1.5

      • getCategory

        public final Class<? extends Attribute> getCategory()
        この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

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

        定義:
        getCategory、インタフェース: Attribute
        戻り値:
        印刷属性クラス(category)、クラスjava.lang.Classのインスタンス

      • getName

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

        クラスPrinterStateReasonsの場合、カテゴリ名は"printer-state-reasons"です。

        定義:
        getName、インタフェース: Attribute
        戻り値:
        属性カテゴリ名

      • printerStateReasonSet

        public Set<PrinterStateReason> printerStateReasonSet​(Severity severity)
        このPrinterStateReasons属性で、指定された重大度の個々のプリンタ状態理由属性の変更不可能なセット・ビューを取得します。 セット・ビューの各要素はPrinterStateReasonオブジェクトです。 セット・ビューに含まれる要素は、指定された重要度の値にマッピングされたPrinterStateReasonオブジェクトのみです。 セット・ビューはこのPrinterStateReasons属性によってサポートされているため、このPrinterStateReasons属性への変更はセット・ビューに反映されます。 セット・ビューは要素の追加または削除をサポートしません。 セット・ビューのイテレータは要素の削除をサポートしません。
        パラメータ:
        severity - 重大度
        戻り値:
        指定されたSeverityレベルで個々のPrinterStateReason属性のビューを設定
        例外:
        NullPointerException - severityがnullの場合