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