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