Source for javax.print.attribute.standard.JobImpressionsCompleted

   1: /* JobImpressionsCompleted.java -- 
   2:    Copyright (C) 2003, 2004, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.print.attribute.standard;
  39: 
  40: import javax.print.attribute.IntegerSyntax;
  41: import javax.print.attribute.PrintJobAttribute;
  42: 
  43: /**
  44:  * The <code>JobImpressionsCompleted</code> printing attribute reports
  45:  * the number of impressions already processed.
  46:  * <p>
  47:  * An impression is specified by the IPP specification as the image imposed 
  48:  * onto a single media sheet. This attribute will not include a multiplication 
  49:  * factor from the number of copies.
  50:  * </p>
  51:  * <p>
  52:  * This attribute belongs to a group of job progress attributes which are 
  53:  * reporting on the progress of a print job.
  54:  * </p>
  55:  * <p>
  56:  * <b>IPP Compatibility:</b> JobImpressionsCompleted is an IPP 1.1 attribute.
  57:  * </p>
  58:  * @see javax.print.attribute.standard.JobMediaSheetsCompleted
  59:  * @see javax.print.attribute.standard.JobKOctetsProcessed
  60:  * 
  61:  * @author Michael Koch (konqueror@gmx.de)
  62:  */
  63: public final class JobImpressionsCompleted extends IntegerSyntax
  64:   implements PrintJobAttribute
  65: {
  66:   private static final long serialVersionUID = 6722648442432393294L;
  67:   
  68:   /**
  69:    * Creates a <code>JobImpressionsCompleted</code> object.
  70:    *
  71:    * @param value the number of completed impressions
  72:    *
  73:    * @exception IllegalArgumentException if value &lt; 0
  74:    */
  75:   public JobImpressionsCompleted(int value)
  76:   {
  77:     super(value);
  78: 
  79:     if (value < 0)
  80:       throw new IllegalArgumentException("value may not be less than 0");
  81:   }
  82:   
  83:   /**
  84:    * Tests if the given object is equal to this object.
  85:    *
  86:    * @param obj the object to test
  87:    *
  88:    * @return <code>true</code> if both objects are equal, 
  89:    * <code>false</code> otherwise.
  90:    */
  91:   public boolean equals(Object obj)
  92:   {
  93:     if(! (obj instanceof JobImpressionsCompleted))
  94:       return false;
  95: 
  96:     return super.equals(obj);
  97:   }
  98: 
  99:   /**
 100:    * Returns category of this class.
 101:    *
 102:    * @return The class <code>JobImpressionsCompleted</code> itself.
 103:    */
 104:   public Class getCategory()
 105:   {
 106:     return JobImpressionsCompleted.class;
 107:   }
 108: 
 109:   /**
 110:    * Returns the name of this attribute.
 111:    *
 112:    * @return The name "job-impressions-completed".
 113:    */
 114:   public String getName()
 115:   {
 116:     return "job-impressions-completed";
 117:   }
 118: }