001/* NumberUpSupported.java --
002   Copyright (C) 2004, 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.SetOfIntegerSyntax;
042import javax.print.attribute.SupportedValuesAttribute;
043
044
045/**
046 * The <code>NumberUpSupported</code> printing attribute specifies the 
047 * supported value or range of values for the 
048 * {@link javax.print.attribute.standard.NumberUp} attribute.
049 * <p>
050 * <b>IPP Compatibility:</b> NumberUpSupported is an IPP 1.1 attribute.
051 * </p>
052 * 
053 * @author Michael Koch (konqueror@gmx.de)
054 * @author Wolfgang Baer (WBaer@gmx.de)
055 */
056public final class NumberUpSupported extends SetOfIntegerSyntax
057  implements SupportedValuesAttribute
058{
059  private static final long serialVersionUID = -1041573395759141805L;
060
061  /**
062   * Constructs a <code>NumberUpSupported</code> object.
063   *
064   * @param member the only one value supported for number up.
065   *
066   * @exception IllegalArgumentException if member is &lt; 1
067   */
068  public NumberUpSupported(int member)
069  {
070    super(member);
071    
072    if (member < 1)
073      throw new IllegalArgumentException("member may not be less than 1");
074  }
075
076  /**
077   * Constructs a <code>NumberUpSupported</code> object.
078   *
079   * @param members the members supported for number up.
080   *
081   * @exception IllegalArgumentException if any element is invalid
082   * @exception NullPointerException if members is <code>null</code> or any 
083   * element of members is <code>null</code>.
084   */
085  public NumberUpSupported(int[][] members)
086  {
087    super(members);
088    
089    if (members == null)
090      throw new NullPointerException("members may not be null");
091  }
092
093  /**
094   * Constructs a <code>NumberUpSupported</code> object with the
095   * given range for supported number up values.
096   *
097   * @param lowerBound the lower bound value
098   * @param upperBound the upper bound value
099   *
100   * @exception IllegalArgumentException if lowerBound &lt;= upperbound
101   * and lowerBound &lt; 1
102   */
103  public NumberUpSupported(int lowerBound, int upperBound)
104  {
105    super(lowerBound, upperBound);
106    
107    if (lowerBound < 1)
108      throw new IllegalArgumentException("lowerBound may not be less than 1");
109  }
110  
111  /**
112   * Tests if the given object is equal to this object.
113   *
114   * @param obj the object to test
115   *
116   * @return <code>true</code> if both objects are equal, 
117   * <code>false</code> otherwise.
118   */
119  public boolean equals(Object obj)
120  {
121    if (! (obj instanceof NumberUpSupported))
122      return false;
123   
124    return super.equals(obj);
125  }
126
127  /**
128   * Returns category of this class.
129   *
130   * @return The class <code>NumberUpSupported</code> itself.
131   */
132  public Class< ? extends Attribute> getCategory()
133  {
134    return NumberUpSupported.class;
135  }
136
137  /**
138   * Returns the name of this attribute.
139   *
140   * @return The name "number-up-supported".
141   */
142  public String getName()
143  {
144    return "number-up-supported";
145  }
146}