Source for javax.print.attribute.standard.JobMediaSheetsCompleted

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