libjava/classpath/javax/print/attribute/standard/JobKOctets.java

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