Source for javax.print.attribute.standard.JobMediaSheets

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