モジュール java.desktop

パッケージ javax.print.attribute.standard

クラスJobStateReasons

java.lang.Object

java.util.AbstractCollection<JobStateReason>

java.util.AbstractSet<JobStateReason>

java.util.HashSet<JobStateReason>

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属性には、印刷ジョブのステータスに関連するゼロ、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()	空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは既定の初期容量と負荷係数を持ちます。
JobStateReasons(int initialCapacity)	空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは指定された初期容量と既定の負荷係数を持ちます。
JobStateReasons(int initialCapacity, float loadFactor)	空のジョブ状態理由属性を新しく構築します。基本となるハッシュ・セットは指定された初期容量と負荷係数を持ちます。
JobStateReasons(Collection<JobStateReason> collection)	指定されコレクションと同じJobStateReasonオブジェクトを持つジョブ状態理由属性を新しく構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	add(JobStateReason o)	指定された要素がこのジョブ状態理由属性に未登録の場合にこれを追加します。
final Class<? extends Attribute>	getCategory()	この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
final String	getName()	属性値がインスタンスとなるカテゴリの名前を返します。

クラスjava.util.HashSetで宣言されたメソッド

clear, clone, contains, isEmpty, iterator, newHashSet, remove, size, spliterator, toArray, toArray

クラスjava.util.AbstractSetで宣言されたメソッド

equals, hashCode, removeAll

クラスjava.util.AbstractCollectionで宣言されたメソッド

addAll, containsAll, retainAll, toArray, toArray, toString

クラスjava.lang.Objectで宣言されたメソッド

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

インタフェースjava.util.Collectionで宣言されたメソッド

parallelStream, removeIf, stream, toArray

インタフェースjava.lang.Iterableで宣言されたメソッド

forEach

インタフェースjava.util.Setで宣言されたメソッド

addAll, containsAll, equals, hashCode, removeAll, retainAll

コンストラクタの詳細

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

戻り値:

印刷属性クラス(category)、クラスjava.lang.Classのインスタンス

getName

public final String getName()

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

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

定義:

getName、インタフェースAttribute

戻り値:

属性カテゴリ名