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

Print this page


   1 /*
   2  * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  30 
  31 /**
  32  * Class JobMediaSheetsCompleted is an integer valued printing attribute class
  33  * that specifies the number of media sheets which have completed marking and
  34  * stacking for the entire job so far, whether those sheets have been processed
  35  * on one side or on both.
  36  * <P>
  37  * The JobMediaSheetsCompleted attribute describes the progress of the job. This
  38  * attribute is intended to be a counter. That is, the JobMediaSheetsCompleted
  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  * JobMediaSheetsCompleted 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 JobMediaSheetsCompleted 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 JobMediaSheets
  53  * @see JobMediaSheetsSupported
  54  * @see JobKOctetsProcessed
  55  * @see JobImpressionsCompleted
  56  *
  57  * @author  Alan Kaminsky
  58  */
  59 public final class JobMediaSheetsCompleted extends IntegerSyntax
  60         implements PrintJobAttribute {
  61 
  62 
  63     private static final long serialVersionUID = 1739595973810840475L;
  64 
  65     /**
  66      * Construct a new job media sheets completed attribute with the given
  67      * integer value.
  68      *
  69      * @param  value  Integer value.
  70      *


   1 /*
   2  * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  30 
  31 /**
  32  * Class JobMediaSheetsCompleted is an integer valued printing attribute class
  33  * that specifies the number of media sheets which have completed marking and
  34  * stacking for the entire job so far, whether those sheets have been processed
  35  * on one side or on both.
  36  * <P>
  37  * The JobMediaSheetsCompleted attribute describes the progress of the job. This
  38  * attribute is intended to be a counter. That is, the JobMediaSheetsCompleted
  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  * JobMediaSheetsCompleted 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 JobMediaSheetsCompleted 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 JobMediaSheets
  52  * @see JobMediaSheetsSupported
  53  * @see JobKOctetsProcessed
  54  * @see JobImpressionsCompleted
  55  *
  56  * @author  Alan Kaminsky
  57  */
  58 public final class JobMediaSheetsCompleted extends IntegerSyntax
  59         implements PrintJobAttribute {
  60 
  61 
  62     private static final long serialVersionUID = 1739595973810840475L;
  63 
  64     /**
  65      * Construct a new job media sheets completed attribute with the given
  66      * integer value.
  67      *
  68      * @param  value  Integer value.
  69      *