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.SetOfIntegerSyntax;
029 import javax.print.attribute.SupportedValuesAttribute;
030
031 /**
032 * Class JobKOctetsSupported is a printing attribute class, a set of integers,
033 * that gives the supported values for a {@link JobKOctets JobKOctets}
034 * attribute. It is restricted to a single contiguous range of integers;
035 * multiple non-overlapping ranges are not allowed. This gives the lower and
036 * upper bounds of the total sizes of print jobs in units of K octets (1024
037 * octets) that the printer will accept.
038 * <P>
039 * <B>IPP Compatibility:</B> The JobKOctetsSupported attribute's canonical array
040 * form gives the lower and upper bound for the range of values to be included
041 * in an IPP "job-k-octets-supported" attribute. See class {@link
042 * javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an
043 * explanation of canonical array form. The category name returned by
044 * <CODE>getName()</CODE> gives the IPP attribute name.
045 * <P>
046 *
047 * @author Alan Kaminsky
048 */
049 public final class JobKOctetsSupported extends SetOfIntegerSyntax
050 implements SupportedValuesAttribute {
051
052 private static final long serialVersionUID = -2867871140549897443L;
053
054 /**
055 * Construct a new job K octets supported attribute containing a single
056 * range of integers. That is, only those values of JobKOctets in the one
057 * range are supported.
058 *
059 * @param lowerBound Lower bound of the range.
060 * @param upperBound Upper bound of the range.
061 *
062 * @exception IllegalArgumentException
063 * (Unchecked exception) Thrown if a null range is specified or if a
064 * non-null range is specified with <CODE>lowerBound</CODE> less than
065 * 0.
066 */
067 public JobKOctetsSupported(int lowerBound, int upperBound) {
068 super (lowerBound, upperBound);
069 if (lowerBound > upperBound) {
070 throw new IllegalArgumentException("Null range specified");
071 } else if (lowerBound < 0) {
072 throw new IllegalArgumentException(
073 "Job K octets value < 0 specified");
074 }
075 }
076
077 /**
078 * Returns whether this job K octets supported attribute is equivalent to
079 * the passed in object. To be equivalent, all of the following conditions
080 * must be true:
081 * <OL TYPE=1>
082 * <LI>
083 * <CODE>object</CODE> is not null.
084 * <LI>
085 * <CODE>object</CODE> is an instance of class JobKOctetsSupported.
086 * <LI>
087 * This job K octets supported attribute's members and
088 * <CODE>object</CODE>'s members are the same.
089 * </OL>
090 *
091 * @param object Object to compare to.
092 *
093 * @return True if <CODE>object</CODE> is equivalent to this job K
094 * octets supported attribute, false otherwise.
095 */
096 public boolean equals(Object object) {
097 return (super .equals(object) && object instanceof JobKOctetsSupported);
098 }
099
100 /**
101 * Get the printing attribute class which is to be used as the "category"
102 * for this printing attribute value.
103 * <P>
104 * For class JobKOctetsSupported, the category is class
105 * JobKOctetsSupported itself.
106 *
107 * @return Printing attribute class (category), an instance of class
108 * {@link java.lang.Class java.lang.Class}.
109 */
110 public final Class<? extends Attribute> getCategory() {
111 return JobKOctetsSupported.class;
112 }
113
114 /**
115 * Get the name of the category of which this attribute value is an
116 * instance.
117 * <P>
118 * For class JobKOctetsSupported, the category name is
119 * <CODE>"job-k-octets-supported"</CODE>.
120 *
121 * @return Attribute category name.
122 */
123 public final String getName() {
124 return "job-k-octets-supported";
125 }
126
127 }
|