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