Source for javax.print.attribute.standard.JobKOctets

   1: /* JobKOctets.java -- 
   2:    Copyright (C) 2003, 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: import javax.print.attribute.PrintRequestAttribute;
  44: 
  45: /**
  46:  * The <code>JobKOctets</code> printing attribute specifies
  47:  * the total size of all the documents of a print job in K octets.
  48:  * <p>
  49:  * The supplied value has to be rounded up, so that a range between
  50:  * 1 and 1024 octects is specified as 1 and a range between 1025 and
  51:  * 2048 octects as 2, etc.  This attribute must not include a multiplication 
  52:  * factor from the number of copies which maybe specified in a Copies 
  53:  * attribute.
  54:  * </p>
  55:  * <p>
  56:  * This attribute belongs to a group of job size attributes which are 
  57:  * describing the size of a job to be printed. The values supplied by
  58:  * these attributes are intended to be used for routing and scheduling
  59:  * of jobs on the print service. A client may specify these attributes.
  60:  * If a clients supplies these attributes a print service may change
  61:  * the values if its be able to compute a more accurate value at the
  62:  * time of the job submission or also later.
  63:  * </p>
  64:  * <p>
  65:  * <b>IPP Compatibility:</b> JobKOctets is an IPP 1.1 attribute.
  66:  * </p>
  67:  * @see javax.print.attribute.standard.JobMediaSheets
  68:  * @see javax.print.attribute.standard.JobImpressions
  69:  * 
  70:  * @author Michael Koch
  71:  */
  72: public final class JobKOctets extends IntegerSyntax
  73:   implements PrintJobAttribute, PrintRequestAttribute
  74: {
  75:   private static final long serialVersionUID = -8959710146498202869L;
  76:   
  77:   /**
  78:    * Creates a <code>JobKOctets</code> object.
  79:    * The value is in units of K (1024) octets rounded up to the next highest K. 
  80:    *
  81:    * @param value the number of K octets
  82:    *
  83:    * @exception IllegalArgumentException if value &lt; 0
  84:    */
  85:   public JobKOctets(int value)
  86:   {
  87:     super(value);
  88: 
  89:     if (value < 0)
  90:       throw new IllegalArgumentException("value may not be less than 0");
  91:   }
  92:   
  93:   /**
  94:    * Tests if the given object is equal to this object.
  95:    *
  96:    * @param obj the object to test
  97:    *
  98:    * @return <code>true</code> if both objects are equal, 
  99:    * <code>false</code> otherwise.
 100:    */
 101:   public boolean equals(Object obj)
 102:   {
 103:     if(! (obj instanceof JobKOctets))
 104:       return false;
 105: 
 106:     return super.equals(obj);
 107:   }
 108: 
 109:   /**
 110:    * Returns category of this class.
 111:    *
 112:    * @return The class <code>JobKOctets</code> itself.
 113:    */
 114:   public Class< ? extends Attribute> getCategory()
 115:   {
 116:     return JobKOctets.class;
 117:   }
 118: 
 119:   /**
 120:    * Returns the name of this attribute.
 121:    *
 122:    * @return The name "job-k-octets".
 123:    */
 124:   public String getName()
 125:   {
 126:     return "job-k-octets";
 127:   }
 128: }