モジュール 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属性には、印刷ジョブのステータスに関連する0、1または複数のJobStateReasonオブジェクトが含まれます。 プリンタは印刷ジョブの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 - 初期容量が負の場合

      • JobStateReasons

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

      • 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
        戻り値:
        属性カテゴリ名