< prev index next >
src/java.desktop/share/classes/javax/print/attribute/standard/JobKOctetsSupported.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2017, 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
@@ -20,50 +20,52 @@
*
* 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 JobKOctetsSupported is a printing attribute class, a set of integers,
- * that gives the supported values for a {@link JobKOctets JobKOctets}
+ * Class {@code JobKOctetsSupported} is a printing attribute class, a set of
+ * integers, that gives the supported values for a {@link JobKOctets JobKOctets}
* attribute. It is restricted to a single contiguous range of integers;
* multiple non-overlapping ranges are not allowed. This gives the lower and
* upper bounds of the total sizes of print jobs in units of K octets (1024
* octets) that the printer will accept.
- * <P>
- * <B>IPP Compatibility:</B> The JobKOctetsSupported attribute's canonical array
- * form gives the lower and upper bound for the range of values to be included
- * in an IPP "job-k-octets-supported" attribute. See class {@link
- * javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an
- * explanation of canonical array form. The category name returned by
- * {@code getName()} gives the IPP attribute name.
+ * <p>
+ * <b>IPP Compatibility:</b> The {@code JobKOctetsSupported} attribute's
+ * canonical array form gives the lower and upper bound for the range of values
+ * to be included in an IPP "job-k-octets-supported" attribute. See class
+ * {@link SetOfIntegerSyntax SetOfIntegerSyntax} for an explanation of canonical
+ * array form. The category name returned by {@code getName()} gives the IPP
+ * attribute name.
*
* @author Alan Kaminsky
*/
public final class JobKOctetsSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute {
+ /**
+ * Use serialVersionUID from JDK 1.4 for interoperability.
+ */
private static final long serialVersionUID = -2867871140549897443L;
/**
* Construct a new job K octets supported attribute containing a single
* range of integers. That is, only those values of JobKOctets 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 {@code lowerBound} less than
- * 0.
+ * @param lowerBound Lower bound of the range
+ * @param upperBound Upper bound of the range
+ * @throws IllegalArgumentException if a {@code null} range is specified or
+ * if a {@code non-null} range is specified with {@code lowerBound}
+ * less than zero
*/
public JobKOctetsSupported(int lowerBound, int upperBound) {
super (lowerBound, upperBound);
if (lowerBound > upperBound) {
throw new IllegalArgumentException("Null range specified");
@@ -75,53 +77,48 @@
/**
* Returns whether this job K octets supported attribute is equivalent to
* the passed in object. To be equivalent, all of the following conditions
* must be true:
- * <OL TYPE=1>
- * <LI>
- * {@code object} is not null.
- * <LI>
- * {@code object} is an instance of class JobKOctetsSupported.
- * <LI>
- * This job K octets supported attribute's members and
+ * <ol type=1>
+ * <li>{@code object} is not {@code null}.
+ * <li>{@code object} is an instance of class {@code JobKOctetsSupported}.
+ * <li>This job K octets supported attribute's members and
* {@code object}'s members are the same.
- * </OL>
- *
- * @param object Object to compare to.
+ * </ol>
*
- * @return True if {@code object} is equivalent to this job K
- * octets supported attribute, false otherwise.
+ * @param object {@code Object} to compare to
+ * @return {@code true} if {@code object} is equivalent to this job K octets
+ * supported attribute, {@code false} otherwise
*/
public boolean equals(Object object) {
return (super.equals (object) &&
object instanceof JobKOctetsSupported);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
- * <P>
- * For class JobKOctetsSupported, the category is class
- * JobKOctetsSupported itself.
+ * <p>
+ * For class {@code JobKOctetsSupported}, the category is class
+ * {@code JobKOctetsSupported} itself.
*
- * @return Printing attribute class (category), an instance of class
- * {@link java.lang.Class java.lang.Class}.
+ * @return printing attribute class (category), an instance of class
+ * {@link Class java.lang.Class}
*/
public final Class<? extends Attribute> getCategory() {
return JobKOctetsSupported.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
- * <P>
- * For class JobKOctetsSupported, the category name is
+ * <p>
+ * For class {@code JobKOctetsSupported}, the category name is
* {@code "job-k-octets-supported"}.
*
- * @return Attribute category name.
+ * @return attribute category name
*/
public final String getName() {
return "job-k-octets-supported";
}
-
}
< prev index next >