src/share/classes/javax/print/attribute/standard/JobImpressionsCompleted.java

Print this page




  30 
  31 /**
  32  * Class JobImpressionsCompleted is an integer valued printing attribute class
  33  * that specifies the number of impressions completed for the job so far. For
  34  * printing devices, the impressions completed includes interpreting, marking,
  35  * and stacking the output.
  36  * <P>
  37  * The JobImpressionsCompleted attribute describes the progress of the job. This
  38  * attribute is intended to be a counter. That is, the JobImpressionsCompleted
  39  * value for a job that has not started processing must be 0. When the job's
  40  * {@link JobState JobState} is PROCESSING or PROCESSING_STOPPED, the
  41  * JobImpressionsCompleted value is intended to increase as the job is
  42  * processed; it indicates the amount of the job that has been processed at the
  43  * time the Print Job's attribute set is queried or at the time a print job
  44  * event is reported. When the job enters the COMPLETED, CANCELED, or ABORTED
  45  * states, the JobImpressionsCompleted value is the final value for the job.
  46  * <P>
  47  * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
  48  * category name returned by <CODE>getName()</CODE> gives the IPP attribute
  49  * name.
  50  * <P>
  51  *
  52  * @see JobImpressions
  53  * @see JobImpressionsSupported
  54  * @see JobKOctetsProcessed
  55  * @see JobMediaSheetsCompleted
  56  *
  57  * @author  Alan Kaminsky
  58  */
  59 public final class JobImpressionsCompleted extends IntegerSyntax
  60         implements PrintJobAttribute {
  61 
  62     private static final long serialVersionUID = 6722648442432393294L;
  63 
  64     /**
  65      * Construct a new job impressions completed attribute with the given
  66      * integer value.
  67      *
  68      * @param  value  Integer value.
  69      *
  70      * @exception  IllegalArgumentException




  30 
  31 /**
  32  * Class JobImpressionsCompleted is an integer valued printing attribute class
  33  * that specifies the number of impressions completed for the job so far. For
  34  * printing devices, the impressions completed includes interpreting, marking,
  35  * and stacking the output.
  36  * <P>
  37  * The JobImpressionsCompleted attribute describes the progress of the job. This
  38  * attribute is intended to be a counter. That is, the JobImpressionsCompleted
  39  * value for a job that has not started processing must be 0. When the job's
  40  * {@link JobState JobState} is PROCESSING or PROCESSING_STOPPED, the
  41  * JobImpressionsCompleted value is intended to increase as the job is
  42  * processed; it indicates the amount of the job that has been processed at the
  43  * time the Print Job's attribute set is queried or at the time a print job
  44  * event is reported. When the job enters the COMPLETED, CANCELED, or ABORTED
  45  * states, the JobImpressionsCompleted value is the final value for the job.
  46  * <P>
  47  * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
  48  * category name returned by <CODE>getName()</CODE> gives the IPP attribute
  49  * name.

  50  *
  51  * @see JobImpressions
  52  * @see JobImpressionsSupported
  53  * @see JobKOctetsProcessed
  54  * @see JobMediaSheetsCompleted
  55  *
  56  * @author  Alan Kaminsky
  57  */
  58 public final class JobImpressionsCompleted extends IntegerSyntax
  59         implements PrintJobAttribute {
  60 
  61     private static final long serialVersionUID = 6722648442432393294L;
  62 
  63     /**
  64      * Construct a new job impressions completed attribute with the given
  65      * integer value.
  66      *
  67      * @param  value  Integer value.
  68      *
  69      * @exception  IllegalArgumentException