Source for javax.print.attribute.standard.NumberOfDocuments

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