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

クラスJobStateReasons

  • すべての実装されたインタフェース:
    Serializable, Cloneable, Iterable<JobStateReason>, Collection<JobStateReason>, Set<JobStateReason>, Attribute, PrintJobAttribute

    public final class JobStateReasons
extends HashSet<JobStateReason>
implements PrintJobAttribute
    JobStateReasonsはジョブの現在の状態についての追加情報、つまりジョブのJobState属性をよりわかりやすくする情報を列挙値のセットとして提供する印刷属性クラスです。

    JobStateReasonのインスタンスは印刷ジョブの属性セットでは直接使用されません。 JobStateReasons属性が使用されます。 JobStateReasons属性には、印刷ジョブのステータスに関連するJobStateReasonオブジェクトがまったく含まれない場合もあり、1つ以上含まれる場合もあります。 プリンタは印刷ジョブのJobStateReasonsオブジェクトに対応する条件がtrueになったときに、JobStateReasonオブジェクトを印刷ジョブのJobStateReasons属性に追加し、falseになったときに、このJobStateReasonを削除します。印刷ジョブ全体のJobStateの変更とは無関係にこの処理が行われます。

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

    IPP互換性: 個々のJobStateReasonオブジェクトのtoString()メソッドによって返される文字列の値はIPPキーワード値を示します。 getName()によって返されるカテゴリ名はIPP属性の名前を示します。

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

    • コンストラクタの詳細

      • JobStateReasons

        public JobStateReasons​()
        空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは既定の初期容量と負荷係数を持ちます。

      • JobStateReasons

        public JobStateReasons​(int initialCapacity)
        空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは指定された初期容量と既定の負荷係数を持ちます。
        パラメータ:
        initialCapacity - 初期容量。
        例外:
        IllegalArgumentException - 初期容量が0よりも小さい場合。

      • JobStateReasons

        public JobStateReasons​(int initialCapacity,
                       float loadFactor)
        空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは指定された初期容量と負荷係数を持ちます。
        パラメータ:
        initialCapacity - 初期容量。
        loadFactor - 負荷係数。
        例外:
        IllegalArgumentException - 初期容量が0よりも小さい場合。

      • JobStateReasons

        public JobStateReasons​(Collection<JobStateReason> collection)
        指定されコレクションと同じJobStateReasonオブジェクトを持つジョブ状態理由属性を新しく構築します。 基本となるハッシュ・セットの初期容量と負荷係数はスーパー・クラスのコンストラクタHashSet(Collection)で指定されます。
        パラメータ:
        collection - コピー元のコレクション。
        例外:
        NullPointerException - 非チェック例外。collectionがnullの場合、またはcollectionのいずれかの要素がnullの場合にスローされる。
        ClassCastException - 非チェック例外。collectionのいずれかの要素がJobStateReasonクラスのインスタンスでない場合にスローされる。

    • メソッドの詳細

      • add

        public boolean add​(JobStateReason o)
        指定された要素がこのジョブ状態理由属性に未登録の場合にこれを追加します。 追加する要素は、JobStateReasonクラスのインスタンスである必要があります。 このジョブ状態理由属性に指定された要素が登録済の場合、このジョブ状態理由属性を変更しないでfalseを返します。
        定義:
        add、インタフェース: Collection<JobStateReason>
        定義:
        add、インタフェース: Set<JobStateReason>
        オーバーライド:
        add、クラス: HashSet<JobStateReason>
        パラメータ:
        o - このジョブ状態理由属性に追加する要素。
        戻り値:
        このジョブ状態理由属性に指定された要素が登録されていない場合はtrue。
        例外:
        NullPointerException - (非チェック例外)指定された要素がnullの場合にスローされる。
        ClassCastException - 非チェック例外。指定した要素がJobStateReasonクラスのインスタンスでない場合にスローされる。
        導入されたバージョン:
        1.5

      • getCategory

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

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

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

      • getName

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

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

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