javax.print.attribute.standard
クラス JobHoldUntil

java.lang.Object
  javax.print.attribute.DateTimeSyntax
      javax.print.attribute.standard.JobHoldUntil

すべての実装されたインタフェース:

Serializable, Cloneable, Attribute, PrintJobAttribute, PrintRequestAttribute

public final class JobHoldUntil
extends DateTimeSyntax
implements PrintRequestAttribute, PrintJobAttribute

JobHoldUntil クラスは、ジョブが印刷の候補となる正確な日付と時刻を指定する日付と時刻属性の印刷属性クラスです。

この属性の値が将来の日付と時刻を指定する場合、プリンタは JOB_HOLD_UNTIL_SPECIFIED の JobStateReason の値を、ジョブの JobStateReason 属性に追加して、ジョブを PENDING_HELD 状態に移行しなければならず、指定された日付と時刻に到達するまで印刷のジョブをスケジュールしてはなりません。

指定された日付と時刻に到達したら、プリンタは JOB_HOLD_UNTIL_SPECIFIED の JobStateReason の値が存在する場合、それをジョブの JobStateReason 属性から削除する必要があります。PENDING_HELD 状態にジョブを保持するほかのジョブの状態理由がない場合、プリンタはジョブを PENDING 状態に移行してジョブを処理対象の候補と見なさなければなりません。

指定された日付と時刻がすでに経過した場合、ジョブはただちに処理対象の候補にしなければなりません。このように、ただちにジョブを処理対象候補にする 1 つの方法は、次のように構築された JobHoldUntil 属性を指定することです (1970 年 1 月 1 日 00:00:00 GMT の日付と時刻を示す場合)。

 JobHoldUntil immediately = new JobHoldUntil (new Date (0L));

クライアントが、この属性を Print Request に指定せず、プリンタがこの属性をサポートする場合、プリンタは、実装に依存するデフォルトの JobHoldUntil の値を、ジョブの送信時間で使用しなければなりません。これは、ほとんどのジョブテンプレート属性と異なり、ジョブ処理時間で必要な場合に使用されます。

年、月、日、時間、分など個々の値から JobHoldUntil 属性を構築するには、Calendar オブジェクトを使用して Date オブジェクトを構築し、次に Date オブジェクトを使用して JobHoldUntil 属性を構築します。JobHoldUntil 属性を年、月、日、時間、分など個々の値に変換するには、Calendar オブジェクトを作成して JobHoldUntil 属性から Date に設定します。

IPP 互換性: IPP はキーワードとして指定された job-hold-until 属性をサポートしますが、IPP は日付と時刻として指定された job-hold-until 属性を現在サポートしていません。ただし、日付と時刻は、若干正確性が失われますが、標準 IPP キーワードの 1 つに変換ができます。たとえば、今日の日付と現地時間 pm 9:00 の JobHoldUntil 値は、標準 IPP キーワード「night」に変換できます。getName() によって返されるカテゴリ名は IPP 属性名を指定します。

関連項目:

直列化された形式

コンストラクタの概要

JobHoldUntil(Date dateTime)
指定された Date の値で、新しいジョブ保留日時属性を構築します。

メソッドの概要

boolean	equals(Object object) このジョブ保留属性がオブジェクトに渡された属性と等しいかどうかを返します。
Class<? extends Attribute>	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
String	getName() 属性値がインスタンスとなるカテゴリの名前を返します。

クラス javax.print.attribute.DateTimeSyntax から継承されたメソッド

getValue, hashCode, toString

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

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

コンストラクタの詳細

JobHoldUntil

public JobHoldUntil(Date dateTime)

指定された Date の値で、新しいジョブ保留日時属性を構築します。

パラメータ:

dateTime - Date 値

例外:

NullPointerException - 未確認の例外。dateTime が null の場合、スローされる

メソッドの詳細

equals

public boolean equals(Object object)

このジョブ保留属性がオブジェクトに渡された属性と等しいかどうかを返します。同等であるためには、次の条件のすべてが true でなければなりません。

1. object が null ではない
2. object が JobHoldUntil クラスのインスタンスである
3. このジョブ保留属性の Date の値と object の Date の値が等しい

オーバーライド:

クラス DateTimeSyntax 内の equals

パラメータ:

object - 比較対象のオブジェクト

戻り値:

object がこのジョブ保留属性と等しい場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

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

JobHoldUntil クラスの場合、カテゴリ名は job-hold-until です。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前