< prev index next >

src/java.desktop/share/classes/javax/print/attribute/standard/JobPrioritySupported.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,104 +20,99 @@
  *
  * 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.IntegerSyntax;
 import javax.print.attribute.SupportedValuesAttribute;
 
 /**
- * Class JobPrioritySupported is an integer valued printing attribute class
- * that specifies whether a Print Service instance supports the {@link
- * JobPriority JobPriority} attribute and the number of different job priority
- * levels supported.
- * <P>
- * The client can always specify any {@link JobPriority JobPriority} value
- * from 1 to 100 for a job. However, the Print Service instance may support
- * fewer than 100 different job priority levels. If this is the case, the
- * Print Service instance automatically maps the client-specified job priority
- * value to one of the supported job priority levels, dividing the 100 job
- * priority values equally among the available job priority levels.
- * <P>
- * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
- * The category name returned by {@code getName()} gives the IPP
- * attribute name.
+ * Class {@code JobPrioritySupported} is an integer valued printing attribute
+ * class that specifies whether a Print Service instance supports the
+ * {@link JobPriority JobPriority} attribute and the number of different job
+ * priority levels supported.
+ * <p>
+ * The client can always specify any {@link JobPriority JobPriority} value from
+ * 1 to 100 for a job. However, the Print Service instance may support fewer
+ * than 100 different job priority levels. If this is the case, the Print
+ * Service instance automatically maps the client-specified job priority value
+ * to one of the supported job priority levels, dividing the 100 job priority
+ * values equally among the available job priority levels.
+ * <p>
+ * <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The
+ * category name returned by {@code getName()} gives the IPP attribute name.
  *
  * @author  Alan Kaminsky
  */
 public final class JobPrioritySupported extends IntegerSyntax
     implements SupportedValuesAttribute {
 
+    /**
+     * Use serialVersionUID from JDK 1.4 for interoperability.
+     */
     private static final long serialVersionUID = 2564840378013555894L;
 
-
     /**
      * Construct a new job priority supported attribute with the given integer
      * value.
      *
-     * @param  value  Number of different job priority levels supported.
-     *
-     * @exception  IllegalArgumentException
-     *     (Unchecked exception) Thrown if {@code value} is less than 1
-     *     or greater than 100.
+     * @param  value number of different job priority levels supported
+     * @throws IllegalArgumentException if {@code value} is less than 1 or
+     *         greater than 100
      */
     public JobPrioritySupported(int value) {
         super (value, 1, 100);
     }
 
     /**
      * Returns whether this job priority 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 JobPrioritySupported.
-     * <LI>
-     * This job priority supported attribute's value and
-     * {@code object}'s value are equal.
-     * </OL>
-     *
-     * @param  object  Object to compare to.
-     *
-     * @return  True if {@code object} is equivalent to this job
-     *          priority supported attribute, false otherwise.
+     * <ol type=1>
+     *   <li>{@code object} is not {@code null}.
+     *   <li>{@code object} is an instance of class
+     *   {@code JobPrioritySupported}.
+     *   <li>This job priority supported attribute's value and {@code object}'s
+     *   value are equal.
+     * </ol>
+     *
+     * @param  object {@code Object} to compare to
+     * @return {@code true} if {@code object} is equivalent to this job priority
+     *         supported attribute, {@code false} otherwise
      */
     public boolean equals (Object object) {
 
         return (super.equals(object) &&
                object instanceof JobPrioritySupported);
     }
 
-
     /**
      * Get the printing attribute class which is to be used as the "category"
      * for this printing attribute value.
-     * <P>
-     * For class JobPrioritySupported, the
-     * category is class JobPrioritySupported itself.
+     * <p>
+     * For class {@code JobPrioritySupported}, the category is class
+     * {@code JobPrioritySupported} 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 JobPrioritySupported.class;
     }
 
     /**
      * Get the name of the category of which this attribute value is an
      * instance.
-     * <P>
-     * For class JobPrioritySupported, the
-     * category name is {@code "job-priority-supported"}.
+     * <p>
+     * For class {@code JobPrioritySupported}, the category name is
+     * {@code "job-priority-supported"}.
      *
-     * @return  Attribute category name.
+     * @return attribute category name
      */
     public final String getName() {
         return "job-priority-supported";
     }
-
 }
< prev index next >