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