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値を、ジョブのJobStateReasons属性に追加して、ジョブをPENDING_HELD状態に移行しなければならず、指定された日付と時間になるまで印刷のジョブをスケジュールしてはいけません。

指定された日付と時間になったら、プリンタはJOB_HOLD_UNTIL_SPECIFIEDのJobStateReason値が存在する場合、それをジョブのJobStateReasons属性から削除する必要があります。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つに変換できます。たとえば、今日の日付と現地時間9:00pmの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値が等しい。

オーバーライド:

equals、クラス: DateTimeSyntax

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

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

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前