javax.print.attribute.standard
クラス JobStateReasons

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<E>
          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 属性には、印刷ジョブのステータスに関連する JobStateReason オブジェクトがまったく含まれない場合もあり、1 つ以上含まれる場合もあります。プリンタは印刷ジョブの JobStateReason オブジェクトに対応する条件が true になったときに、JobStateReason オブジェクトを印刷ジョブの JobStateReasons 属性に追加し、false になったときに、このオブジェクトを削除します。 印刷ジョブ全体の JobState の変更とは無関係にこの処理が行われます。

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

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

関連項目:

直列化された形式

コンストラクタの概要

JobStateReasons()
空のジョブ状態理由属性を新しく構築します。

JobStateReasons(Collection<JobStateReason> collection)
指定されたコレクションと同じ JobStateReason オブジェクトを持つジョブ状態理由属性を新しく構築します。

JobStateReasons(int initialCapacity)
空のジョブ状態理由属性を新しく構築します。

JobStateReasons(int initialCapacity, float loadFactor)
空のジョブ状態理由属性を新しく構築します。

メソッドの概要

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

クラス java.util.HashSet から継承されたメソッド

clear, clone, contains, isEmpty, iterator, remove, size

クラス 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.Set から継承されたメソッド

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

コンストラクタの詳細

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 を返します。

定義:

インタフェース Collection<JobStateReason> 内の add

定義:

インタフェース Set<JobStateReason> 内の add

オーバーライド:

クラス HashSet<JobStateReason> 内の add

パラメータ:

o - このジョブ状態理由属性に追加する要素

戻り値:

このジョブ状態理由属性に 指定された要素が登録されていない場合は true

例外:

NullPointerException - 指定された要素が null の場合 (未チェック例外)

ClassCastException - 未確認の例外。指定された要素が JobStateReason クラスのインスタンスでない場合にスローされる

導入されたバージョン:

1.5

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

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

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

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前