OpenJDK 27 · javax.print.attribute.standard.JobHoldUntil

Class JobHoldUntil is a printing attribute class, a date-time attribute, that specifies the exact date and time at which the job must become a candidate for printing.

If the value of this attribute specifies a date-time that is in the future, the printer should add the JobStateReason value of JOB_HOLD_UNTIL_SPECIFIED to the job's JobStateReasons attribute, must move the job to the PENDING_HELD state, and must not schedule the job for printing until the specified date-time arrives.

When the specified date-time arrives, the printer must remove the JobStateReason value of JOB_HOLD_UNTIL_SPECIFIED from the job's JobStateReasons attribute, if present. If there are no other job state reasons that keep the job in the PENDING_HELD state, the printer must consider the job as a candidate for processing by moving the job to the PENDING state.

If the specified date-time has already passed, the job must be a candidate for processing immediately. Thus, one way to make the job immediately become a candidate for processing is to specify a JobHoldUntil attribute constructed like this (denoting a date-time of January 1, 1970, 00:00:00 GMT):

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

If the client does not supply this attribute in a Print Request and the printer supports this attribute, the printer must use its (implementation-dependent) default JobHoldUntil value at job submission time (unlike most job template attributes that are used if necessary at job processing time).

To construct a JobHoldUntil attribute from separate values of the year, month, day, hour, minute, and so on, use a Calendar object to construct a Date object, then use the Date object to construct the JobHoldUntil attribute. To convert a JobHoldUntil attribute to separate values of the year, month, day, hour, minute, and so on, create a Calendar object and set it to the Date from the JobHoldUntil attribute.

IPP Compatibility: Although IPP supports a "job-hold-until" attribute specified as a keyword, IPP does not at this time support a "job-hold-until" attribute specified as a date and time. However, the date and time can be converted to one of the standard IPP keywords with some loss of precision; for example, a JobHoldUntil value with today's date and 9:00pm local time might be converted to the standard IPP keyword "night". The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.DateTimeSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Access	Constructor and Description
public	JobHoldUntil(Date `Date` value dateTime) Construct a new job hold until date-time attribute with the given `Date` value.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this job hold until attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.DateTimeSyntax.equals. Returns whether this job hold until attribute is equivalent to the passed in object.
public final Class<? extends Attribute>	Returns: printing attribute class (category), an instance of class `java.lang.Class` getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
public final String	Returns: attribute category name getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.DateTimeSyntax:: getValue hashCode toString

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.DateTimeSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

JobHoldUntil	back to summary
public JobHoldUntil(Date dateTime) Construct a new job hold until date-time attribute with the given `Date` value. Parameters dateTime:Date `Date` value Exceptions NullPointerException: if `dateTime` is `null`

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.DateTimeSyntax.equals. Returns whether this job hold until attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true: `object` is not `null`. `object` is an instance of class `JobHoldUntil`. This job hold until attribute's `Date` value and `object`'s `Date` value are equal. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this job hold until attribute, `false` otherwise Annotations @Override

public boolean equals(Object object)

Overrides javax.print.attribute.DateTimeSyntax.equals.

Returns whether this job hold until attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

object is not null.
object is an instance of class JobHoldUntil.
This job hold until attribute's Date value and object's Date value are equal.

Parameters

object:Object: Object to compare to

Returns:boolean

true if object is equivalent to this job hold until attribute, false otherwise

Annotations

@Override

getCategory back to summary

getCategory	back to summary
public final Class<? extends Attribute> getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class `JobHoldUntil`, the category is class `JobHoldUntil` itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class JobHoldUntil, the category is class JobHoldUntil itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations

@Override

getName back to summary

getName	back to summary
public final String getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance. For class `JobHoldUntil`, the category name is `"job-hold-until"`. Returns:String attribute category name Annotations @Override

public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

For class JobHoldUntil, the category name is "job-hold-until".

Returns:String

attribute category name

Annotations

@Override

public final Class JobHoldUntil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail