Source for javax.print.attribute.standard.JobKOctetsProcessed

   1: /* JobKOctetsProcessed.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>JobKOctetsProcessed</code> printing attribute reports
  46:  * the total number of octets already processed in K octets units.
  47:  * <p>
  48:  * The supplied value will be rounded up to the next highest K octets.
  49:  * This attribute will not include a multiplication factor from the number 
  50:  * 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> JobKOctetsProcessed is an IPP 1.1 attribute.
  58:  * </p>
  59:  * @see javax.print.attribute.standard.JobMediaSheetsCompleted
  60:  * @see javax.print.attribute.standard.JobImpressionsCompleted
  61:  * 
  62:  * @author Michael Koch
  63:  */
  64: public final class JobKOctetsProcessed extends IntegerSyntax
  65:   implements PrintJobAttribute
  66: {
  67:   private static final long serialVersionUID = -6265238509657881806L;
  68:   
  69:   /**
  70:    * Creates a <code>JobKOctetsProcessed</code> object.
  71:    * The value is in units of K (1024) octets rounded up to the next highest K. 
  72:    *
  73:    * @param value the number of processed K octets
  74:    *
  75:    * @exception IllegalArgumentException if value &lt; 0
  76:    */
  77:   public JobKOctetsProcessed(int value)
  78:   {
  79:     super(value);
  80: 
  81:     if (value < 0)
  82:       throw new IllegalArgumentException("value may not be less than 0");
  83:   }
  84:   
  85:   /**
  86:    * Tests if the given object is equal to this object.
  87:    *
  88:    * @param obj the object to test
  89:    *
  90:    * @return <code>true</code> if both objects are equal, 
  91:    * <code>false</code> otherwise.
  92:    */
  93:   public boolean equals(Object obj)
  94:   {
  95:     if(! (obj instanceof JobKOctetsProcessed))
  96:       return false;
  97: 
  98:     return super.equals(obj);
  99:   }
 100: 
 101:   /**
 102:    * Returns category of this class.
 103:    *
 104:    * @return The class <code>JobKOctetsProcessed</code> itself.
 105:    */
 106:   public Class< ? extends Attribute> getCategory()
 107:   {
 108:     return JobKOctetsProcessed.class;
 109:   }
 110: 
 111:   /**
 112:    * Returns the name of this attribute.
 113:    *
 114:    * @return The name "job-k-octets-processed".
 115:    */
 116:   public String getName()
 117:   {
 118:     return "job-k-octets-processed";
 119:   }
 120: }