001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.IntegerSyntax;
029 import javax.print.attribute.SupportedValuesAttribute;
030
031 /**
032 * Class JobPrioritySupported is an integer valued printing attribute class
033 * that specifies whether a Print Service instance supports the {@link
034 * JobPriority JobPriority} attribute and the number of different job priority
035 * levels supported.
036 * <P>
037 * The client can always specify any {@link JobPriority JobPriority} value
038 * from 1 to 100 for a job. However, the Print Service instance may support
039 * fewer than 100 different job priority levels. If this is the case, the
040 * Print Service instance automatically maps the client-specified job priority
041 * value to one of the supported job priority levels, dividing the 100 job
042 * priority values equally among the available job priority levels.
043 * <P>
044 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
045 * The category name returned by <CODE>getName()</CODE> gives the IPP
046 * attribute name.
047 * <P>
048 *
049 * @author Alan Kaminsky
050 */
051 public final class JobPrioritySupported extends IntegerSyntax implements
052 SupportedValuesAttribute {
053
054 private static final long serialVersionUID = 2564840378013555894L;
055
056 /**
057 * Construct a new job priority supported attribute with the given integer
058 * value.
059 *
060 * @param value Number of different job priority levels supported.
061 *
062 * @exception IllegalArgumentException
063 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 1
064 * or greater than 100.
065 */
066 public JobPrioritySupported(int value) {
067 super (value, 1, 100);
068 }
069
070 /**
071 * Returns whether this job priority supported attribute is equivalent to
072 * the passed in object. To be equivalent, all of the following conditions
073 * must be true:
074 * <OL TYPE=1>
075 * <LI>
076 * <CODE>object</CODE> is not null.
077 * <LI>
078 * <CODE>object</CODE> is an instance of class JobPrioritySupported.
079 * <LI>
080 * This job priority supported attribute's value and
081 * <CODE>object</CODE>'s value are equal.
082 * </OL>
083 *
084 * @param object Object to compare to.
085 *
086 * @return True if <CODE>object</CODE> is equivalent to this job
087 * priority supported attribute, false otherwise.
088 */
089 public boolean equals(Object object) {
090
091 return (super .equals(object) && object instanceof JobPrioritySupported);
092 }
093
094 /**
095 * Get the printing attribute class which is to be used as the "category"
096 * for this printing attribute value.
097 * <P>
098 * For class JobPrioritySupported, the
099 * category is class JobPrioritySupported itself.
100 *
101 * @return Printing attribute class (category), an instance of class
102 * {@link java.lang.Class java.lang.Class}.
103 */
104 public final Class<? extends Attribute> getCategory() {
105 return JobPrioritySupported.class;
106 }
107
108 /**
109 * Get the name of the category of which this attribute value is an
110 * instance.
111 * <P>
112 * For class JobPrioritySupported, the
113 * category name is <CODE>"job-priority-supported"</CODE>.
114 *
115 * @return Attribute category name.
116 */
117 public final String getName() {
118 return "job-priority-supported";
119 }
120
121 }
|