1 /*
   2  * Copyright (c) 2000, 2017, 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
  23  * questions.
  24  */
  25 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.IntegerSyntax;
  30 import javax.print.attribute.PrintJobAttribute;
  31 
  32 /**
  33  * Class {@code JobImpressionsCompleted} is an integer valued printing attribute
  34  * class that specifies the number of impressions completed for the job so far.
  35  * For printing devices, the impressions completed includes interpreting,
  36  * marking, and stacking the output.
  37  * <p>
  38  * The {@code JobImpressionsCompleted} attribute describes the progress of the
  39  * job. This attribute is intended to be a counter. That is, the
  40  * {@code JobImpressionsCompleted} value for a job that has not started
  41  * processing must be 0. When the job's {@link JobState JobState} is
  42  * {@code PROCESSING} or {@code PROCESSING_STOPPED}, the
  43  * {@code JobImpressionsCompleted} value is intended to increase as the job is
  44  * processed; it indicates the amount of the job that has been processed at the
  45  * time the Print Job's attribute set is queried or at the time a print job
  46  * event is reported. When the job enters the {@code COMPLETED},
  47  * {@code CANCELED}, or {@code ABORTED} states, the
  48  * {@code JobImpressionsCompleted} value is the final value for the job.
  49  * <p>
  50  * <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The
  51  * category name returned by {@code getName()} gives the IPP attribute name.
  52  *
  53  * @author Alan Kaminsky
  54  * @see JobImpressions
  55  * @see JobImpressionsSupported
  56  * @see JobKOctetsProcessed
  57  * @see JobMediaSheetsCompleted
  58  */
  59 public final class JobImpressionsCompleted extends IntegerSyntax
  60         implements PrintJobAttribute {
  61 
  62     /**
  63      * Use serialVersionUID from JDK 1.4 for interoperability.
  64      */
  65     private static final long serialVersionUID = 6722648442432393294L;
  66 
  67     /**
  68      * Construct a new job impressions completed attribute with the given
  69      * integer value.
  70      *
  71      * @param  value Integer value
  72      * @throws IllegalArgumentException if {@code value} is negative
  73      */
  74     public JobImpressionsCompleted(int value) {
  75         super (value, 0, Integer.MAX_VALUE);
  76     }
  77 
  78     /**
  79      * Returns whether this job impressions completed attribute is equivalent tp
  80      * the passed in object. To be equivalent, all of the following conditions
  81      * must be true:
  82      * <ol type=1>
  83      *   <li>{@code object} is not {@code null}.
  84      *   <li>{@code object} is an instance of class
  85      *   {@code JobImpressionsCompleted}.
  86      *   <li>This job impressions completed attribute's value and
  87      *   {@code object}'s value are equal.
  88      * </ol>
  89      *
  90      * @param  object {@code Object} to compare to
  91      * @return {@code true} if {@code object} is equivalent to this job
  92      *         impressions completed attribute, {@code false} otherwise
  93      */
  94     public boolean equals(Object object) {
  95         return(super.equals (object) &&
  96                object instanceof JobImpressionsCompleted);
  97     }
  98 
  99     /**
 100      * Get the printing attribute class which is to be used as the "category"
 101      * for this printing attribute value.
 102      * <p>
 103      * For class {@code JobImpressionsCompleted}, the category is class
 104      * {@code JobImpressionsCompleted} itself.
 105      *
 106      * @return printing attribute class (category), an instance of class
 107      *         {@link Class java.lang.Class}
 108      */
 109     public final Class<? extends Attribute> getCategory() {
 110         return JobImpressionsCompleted.class;
 111     }
 112 
 113     /**
 114      * Get the name of the category of which this attribute value is an
 115      * instance.
 116      * <p>
 117      * For class {@code JobImpressionsCompleted}, the category name is
 118      * {@code "job-impressions-completed"}.
 119      *
 120      * @return attribute category name
 121      */
 122     public final String getName() {
 123         return "job-impressions-completed";
 124     }
 125 }