/* * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.print.attribute.standard; import javax.print.attribute.Attribute; import javax.print.attribute.SetOfIntegerSyntax; import javax.print.attribute.SupportedValuesAttribute; /** * Class CopiesSupported is a printing attribute class, a set of integers, that * gives the supported values for a {@link Copies Copies} attribute. It is * restricted to a single contiguous range of integers; multiple non-overlapping * ranges are not allowed. *
* IPP Compatibility: The CopiesSupported attribute's canonical array
* form gives the lower and upper bound for the range of copies to be included
* in an IPP "copies-supported" attribute. See class {@link
* javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an
* explanation of canonical array form. The category name returned by
* getName()
gives the IPP attribute name.
*
* @author Alan Kaminsky
*/
public final class CopiesSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute {
private static final long serialVersionUID = 6927711687034846001L;
/**
* Construct a new copies supported attribute containing a single integer.
* That is, only the one value of Copies is supported.
*
* @param member Set member.
*
* @exception IllegalArgumentException
* (Unchecked exception) Thrown if member
is less than 1.
*/
public CopiesSupported(int member) {
super (member);
if (member < 1) {
throw new IllegalArgumentException("Copies value < 1 specified");
}
}
/**
* Construct a new copies supported attribute containing a single range of
* integers. That is, only those values of Copies in the one range are
* supported.
*
* @param lowerBound Lower bound of the range.
* @param upperBound Upper bound of the range.
*
* @exception IllegalArgumentException
* (Unchecked exception) Thrown if a null range is specified or if a
* non-null range is specified with lowerBound
less than
* 1.
*/
public CopiesSupported(int lowerBound, int upperBound) {
super(lowerBound, upperBound);
if (lowerBound > upperBound) {
throw new IllegalArgumentException("Null range specified");
} else if (lowerBound < 1) {
throw new IllegalArgumentException("Copies value < 1 specified");
}
}
/**
* Returns whether this copies supported attribute is equivalent to the
* passed in object. To be equivalent, all of the following conditions must
* be true:
*
object
is not null.
* object
is an instance of class CopiesSupported.
* object
's
* members are the same.
* object
is equivalent to this copies
* supported attribute, false otherwise.
*/
public boolean equals(Object object) {
return super.equals (object) && object instanceof CopiesSupported;
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* * For class CopiesSupported, the category * is class CopiesSupported itself. * * @return Printing attribute class (category), an instance of class * {@link java.lang.Class java.lang.Class}. */ public final Class extends Attribute> getCategory() { return CopiesSupported.class; } /** * Get the name of the category of which this attribute value is an * instance. *
* For class CopiesSupported, the category
* name is "copies-supported"
.
*
* @return Attribute category name.
*/
public final String getName() {
return "copies-supported";
}
}