001/* JobPrioritySupported.java --
002   Copyright (C) 2003, 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.IntegerSyntax;
042import javax.print.attribute.SupportedValuesAttribute;
043
044
045/**
046 * The <code>JobPrioritySupported</code> printing attribute provides
047 * the supported values for the <code>JobPriority</code> attribute.
048 * <p>
049 * A client may specify any JobPriority value between 1 and 100. If a
050 * print service supports fewer priority levels it indicates the maximum
051 * levels through this attribute. The print service then automatically
052 * maps the job priority value provided by the client in an even distribution
053 * over the whole range of 1 to 100.
054 * </p>
055 * <p>
056 * <b>IPP Compatibility:</b> JobPrioritySupported is an IPP 1.1 attribute.
057 * </p>
058 * @see javax.print.attribute.standard.JobPriority
059 *
060 * @author Michael Koch (konqueror@gmx.de)
061 */
062public final class JobPrioritySupported extends IntegerSyntax
063  implements SupportedValuesAttribute
064{
065  private static final long serialVersionUID = 2564840378013555894L;
066
067  /**
068   * Creates a <code>JobPrioritySupported</code> object.
069   *
070   * @param value the priority
071   *
072   * @exception IllegalArgumentException if value &lt; 1 or value &gt; 100
073   */
074  public JobPrioritySupported(int value)
075  {
076    super(value);
077
078    if (value < 1 || value > 100)
079      throw new IllegalArgumentException("value out of range");
080  }
081
082  /**
083   * Tests if the given object is equal to this object.
084   *
085   * @param obj the object to test
086   *
087   * @return <code>true</code> if both objects are equal,
088   * <code>false</code> otherwise.
089   */
090  public boolean equals(Object obj)
091  {
092    if(! (obj instanceof JobPrioritySupported))
093      return false;
094
095    return super.equals(obj);
096  }
097
098  /**
099   * Returns category of this class.
100   *
101   * @return The class <code>JobPrioritySupported</code> itself.
102   */
103  public Class< ? extends Attribute> getCategory()
104  {
105    return JobPrioritySupported.class;
106  }
107
108  /**
109   * Returns the name of this attribute.
110   *
111   * @return The name "job-priority-supported".
112   */
113  public String getName()
114  {
115    return "job-priority-supported";
116  }
117}