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.Attribute;
  41: import javax.print.attribute.IntegerSyntax;
  42: import javax.print.attribute.PrintJobAttribute;
  43: 
  44: /**
  45:  * The <code>JobImpressionsCompleted</code> printing attribute reports
  46:  * the number of impressions already processed.
  47:  * <p>
  48:  * An impression is specified by the IPP specification as the image imposed 
  49:  * onto a single media sheet. This attribute will not include a multiplication 
  50:  * factor from the number of copies.
  51:  * </p>
  52:  * <p>
  53:  * This attribute belongs to a group of job progress attributes which are 
  54:  * reporting on the progress of a print job.
  55:  * </p>
  56:  * <p>
  57:  * <b>IPP Compatibility:</b> JobImpressionsCompleted is an IPP 1.1 attribute.
  58:  * </p>
  59:  * @see javax.print.attribute.standard.JobMediaSheetsCompleted
  60:  * @see javax.print.attribute.standard.JobKOctetsProcessed
  61:  * 
  62:  * @author Michael Koch (konqueror@gmx.de)
  63:  */
  64: public final class JobImpressionsCompleted extends IntegerSyntax
  65:   implements PrintJobAttribute
  66: {
  67:   private static final long serialVersionUID = 6722648442432393294L;
  68:   
  69:   /**
  70:    * Creates a <code>JobImpressionsCompleted</code> object.
  71:    *
  72:    * @param value the number of completed impressions
  73:    *
  74:    * @exception IllegalArgumentException if value &lt; 0
  75:    */
  76:   public JobImpressionsCompleted(int value)
  77:   {
  78:     super(value);
  79: 
  80:     if (value < 0)
  81:       throw new IllegalArgumentException("value may not be less than 0");
  82:   }
  83:   
  84:   /**
  85:    * Tests if the given object is equal to this object.
  86:    *
  87:    * @param obj the object to test
  88:    *
  89:    * @return <code>true</code> if both objects are equal, 
  90:    * <code>false</code> otherwise.
  91:    */
  92:   public boolean equals(Object obj)
  93:   {
  94:     if(! (obj instanceof JobImpressionsCompleted))
  95:       return false;
  96: 
  97:     return super.equals(obj);
  98:   }
  99: 
 100:   /**
 101:    * Returns category of this class.
 102:    *
 103:    * @return The class <code>JobImpressionsCompleted</code> itself.
 104:    */
 105:   public Class< ? extends Attribute> getCategory()
 106:   {
 107:     return JobImpressionsCompleted.class;
 108:   }
 109: 
 110:   /**
 111:    * Returns the name of this attribute.
 112:    *
 113:    * @return The name "job-impressions-completed".
 114:    */
 115:   public String getName()
 116:   {
 117:     return "job-impressions-completed";
 118:   }
 119: }