- * Instances of Severity do not appear in a Print Service's attribute set - * directly. Rather, a {@link PrinterStateReasons PrinterStateReasons} + * Class {@code Severity} is a printing attribute class, an enumeration, that + * denotes the severity of a {@link PrinterStateReason PrinterStateReason} + * attribute. + *
+ * Instances of {@code Severity} do not appear in a Print Service's attribute + * set directly. Rather, a {@link PrinterStateReasons PrinterStateReasons} * attribute appears in the Print Service's attribute set. - * The {@link PrinterStateReasons - * PrinterStateReasons} attribute contains zero, one, or more than one {@link - * PrinterStateReason PrinterStateReason} objects which pertain to the Print - * Service's status, and each {@link PrinterStateReason PrinterStateReason} - * object is associated with a Severity level of REPORT (least severe), - * WARNING, or ERROR (most severe). - * The printer adds a {@link PrinterStateReason - * PrinterStateReason} object to the Print Service's + * The {@link PrinterStateReasons PrinterStateReasons} attribute contains zero, + * one, or more than one {@link PrinterStateReason PrinterStateReason} objects + * which pertain to the Print Service's status, and each + * {@link PrinterStateReason PrinterStateReason} object is associated with a + * Severity level of {@code REPORT} (least severe), {@code WARNING}, or + * {@code ERROR} (most severe). The printer adds a + * {@link PrinterStateReason PrinterStateReason} object to the Print Service's * {@link PrinterStateReasons PrinterStateReasons} attribute when the - * corresponding condition becomes true - * of the printer, and the printer removes the {@link PrinterStateReason - * PrinterStateReason} object again when the corresponding condition becomes - * false, regardless of whether the Print Service's overall - * {@link PrinterState PrinterState} also changed. - *
- * IPP Compatibility: - * {@code Severity.toString()} returns either "error", "warning", or - * "report". The string values returned by - * each individual {@link PrinterStateReason} and - * associated {@link Severity} object's {@code toString()} - * methods, concatenated together with a hyphen ({@code "-"}) in - * between, gives the IPP keyword value for a {@link PrinterStateReasons}. - * The category name returned by {@code getName()} gives the IPP - * attribute name. + * corresponding condition becomes true of the printer, and the printer removes + * the {@link PrinterStateReason PrinterStateReason} object again when the + * corresponding condition becomes false, regardless of whether the Print + * Service's overall {@link PrinterState PrinterState} also changed. + *
+ * IPP Compatibility: {@code Severity.toString()} returns either "error", + * "warning", or "report". The string values returned by each individual + * {@link PrinterStateReason} and associated {@link Severity} object's + * {@code toString()} methods, concatenated together with a hyphen ({@code "-"}) + * in between, gives the IPP keyword value for a {@link PrinterStateReasons}. + * The category name returned by {@code getName()} gives the IPP attribute name. * - * @author Alan Kaminsky + * @author Alan Kaminsky */ public final class Severity extends EnumSyntax implements Attribute { + /** + * Use serialVersionUID from JDK 1.4 for interoperability. + */ private static final long serialVersionUID = 8781881462717925380L; /** * Indicates that the {@link PrinterStateReason PrinterStateReason} is a - * "report" (least severe). An implementation may choose to omit some or - * all reports. - * Some reports specify finer granularity about the printer state; + * "report" (least severe). An implementation may choose to omit some or all + * reports. Some reports specify finer granularity about the printer state; * others serve as a precursor to a warning. A report must contain nothing * that could affect the printed output. */ @@ -78,36 +77,41 @@ /** * Indicates that the {@link PrinterStateReason PrinterStateReason} is a * "warning." An implementation may choose to omit some or all warnings. - * Warnings serve as a precursor to an error. A warning must contain - * nothing that prevents a job from completing, though in some cases the - * output may be of lower quality. + * Warnings serve as a precursor to an error. A warning must contain nothing + * that prevents a job from completing, though in some cases the output may + * be of lower quality. */ public static final Severity WARNING = new Severity (1); /** * Indicates that the {@link PrinterStateReason PrinterStateReason} is an - * "error" (most severe). An implementation must include all errors. - * If this attribute contains one or more errors, the printer's - * {@link PrinterState PrinterState} must be STOPPED. + * "error" (most severe). An implementation must include all errors. If this + * attribute contains one or more errors, the printer's + * {@link PrinterState PrinterState} must be {@code STOPPED}. */ public static final Severity ERROR = new Severity (2); /** - * Construct a new severity enumeration value with the given integer - * value. + * Construct a new severity enumeration value with the given integer value. * - * @param value Integer value. + * @param value Integer value */ protected Severity(int value) { super (value); } + /** + * The string table for class {@code Severity}. + */ private static final String[] myStringTable = { "report", "warning", "error" }; + /** + * The enumeration value table for class {@code Severity}. + */ private static final Severity[] myEnumValueTable = { REPORT, WARNING, @@ -115,28 +119,28 @@ }; /** - * Returns the string table for class Severity. + * Returns the string table for class {@code Severity}. */ protected String[] getStringTable() { return myStringTable; } /** - * Returns the enumeration value table for class Severity. + * Returns the enumeration value table for class {@code Severity}. */ protected EnumSyntax[] getEnumValueTable() { return myEnumValueTable; } - /** * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. - *
- * For class Severity, the category is class Severity itself. + *
+ * For class {@code Severity}, the category is class + * {@code Severity} 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 getCategory() { return Severity.class; @@ -145,13 +149,12 @@ /** * Get the name of the category of which this attribute value is an * instance. - *
- * For class Severit, the category name is {@code "severity"}. + *
+ * For class {@code Severity}, the category name is {@code "severity"}. * - * @return Attribute category name. + * @return attribute category name */ public final String getName() { return "severity"; } - }