- java.lang.Object
-
- javax.print.attribute.DateTimeSyntax
-
- javax.print.attribute.standard.JobHoldUntil
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintJobAttribute,PrintRequestAttribute
public final class JobHoldUntil extends DateTimeSyntax implements PrintRequestAttribute, PrintJobAttribute
ClassJobHoldUntilis 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
JobStateReasonvalue ofJOB_HOLD_UNTIL_SPECIFIEDto the job'sJobStateReasonsattribute, must move the job to thePENDING_HELDstate, 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
JobStateReasonvalue ofJOB_HOLD_UNTIL_SPECIFIEDfrom the job'sJobStateReasonsattribute, if present. If there are no other job state reasons that keep the job in thePENDING_HELDstate, 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
JobHoldUntilattribute 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
JobHoldUntilvalue at job submission time (unlike most job template attributes that are used if necessary at job processing time).To construct a
JobHoldUntilattribute from separate values of the year, month, day, hour, minute, and so on, use aCalendarobject to construct aDateobject, then use theDateobject to construct theJobHoldUntilattribute. To convert aJobHoldUntilattribute to separate values of the year, month, day, hour, minute, and so on, create aCalendarobject and set it to theDatefrom theJobHoldUntilattribute.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
JobHoldUntilvalue with today's date and 9:00pm local time might be converted to the standard IPP keyword "night". The category name returned bygetName()gives the IPP attribute name.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description JobHoldUntil(Date dateTime)Construct a new job hold until date-time attribute with the givenDatevalue.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returns whether this job hold until attribute is equivalent to the passed in object.Class<? extends Attribute>getCategory()Get the printing attribute class which is to be used as the "category" for this printing attribute value.StringgetName()Get the name of the category of which this attribute value is an instance.-
Methods declared in class javax.print.attribute.DateTimeSyntax
getValue, hashCode, toString
-
-
-
-
Constructor Detail
-
JobHoldUntil
public JobHoldUntil(Date dateTime)
Construct a new job hold until date-time attribute with the givenDatevalue.- Parameters:
dateTime-Datevalue- Throws:
NullPointerException- ifdateTimeisnull
-
-
Method Detail
-
equals
public boolean equals(Object object)
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:- Overrides:
equalsin classDateTimeSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this job hold until attribute,falseotherwise- See Also:
Object.hashCode(),HashMap
-
getCategory
public final Class<? extends 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 classJobHoldUntilitself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-