001/* NumberOfDocuments.java --
002   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.attribute.standard;
039
040import javax.print.attribute.Attribute;
041import javax.print.attribute.IntegerSyntax;
042import javax.print.attribute.PrintJobAttribute;
043
044/**
045 * The <code>NumberOfDocuments</code> printing attribute specifies
046 * the number of documents in a job.
047 * <p>
048 * <b>IPP Compatibility:</b> NumberOfDocuments is an IPP 1.1 attribute.
049 * </p>
050 *
051 * @author Michael Koch
052 */
053public final class NumberOfDocuments extends IntegerSyntax
054  implements PrintJobAttribute
055{
056  private static final long serialVersionUID = 7891881310684461097L;
057
058  /**
059   * Creates a <code>NumberOfDocuments</code> object.
060   *
061   * @param value the number of documents
062   *
063   * @exception IllegalArgumentException if value &lt; 0
064   */
065  public NumberOfDocuments(int value)
066  {
067    super(value);
068
069    if (value < 0)
070      throw new IllegalArgumentException("value may not be less than 0");
071  }
072
073  /**
074   * Tests if the given object is equal to this object.
075   *
076   * @param obj the object to test
077   *
078   * @return <code>true</code> if both objects are equal,
079   * <code>false</code> otherwise.
080   */
081  public boolean equals(Object obj)
082  {
083    if(! (obj instanceof NumberOfDocuments))
084      return false;
085
086    return super.equals(obj);
087  }
088
089  /**
090   * Returns category of this class.
091   *
092   * @return The class <code>NumberOfDocuments</code> itself.
093   */
094  public Class< ? extends Attribute> getCategory()
095  {
096    return NumberOfDocuments.class;
097  }
098
099  /**
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}