--- old/src/java.desktop/share/classes/javax/print/attribute/standard/JobState.java 2017-08-11 15:12:43.000000000 -0700 +++ new/src/java.desktop/share/classes/javax/print/attribute/standard/JobState.java 2017-08-11 15:12:43.000000000 -0700 @@ -1,5 +1,5 @@ /* - * 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 @@ -30,24 +30,27 @@ import javax.print.attribute.PrintJobAttribute; /** - * JobState is a printing attribute class, an enumeration, that identifies - * the current state of a print job. Class JobState defines standard job state - * values. A Print Service implementation only needs to report those job - * states which are appropriate for the particular implementation; it does not - * have to report every defined job state. The {@link JobStateReasons - * JobStateReasons} attribute augments the JobState attribute to give more - * detailed information about the job in the given job state. - *

- * IPP Compatibility: The category name returned by - * {@code getName()} is the IPP attribute name. The enumeration's - * integer value is the IPP enum value. The {@code toString()} method - * returns the IPP string representation of the attribute value. + * {@code JobState} is a printing attribute class, an enumeration, that + * identifies the current state of a print job. Class {@code JobState} defines + * standard job state values. A Print Service implementation only needs to + * report those job states which are appropriate for the particular + * implementation; it does not have to report every defined job state. The + * {@link JobStateReasons JobStateReasons} attribute augments the + * {@code JobState} attribute to give more detailed information about the job in + * the given job state. + *

+ * IPP Compatibility: The category name returned by {@code getName()} is + * the IPP attribute name. The enumeration's integer value is the IPP enum + * value. The {@code toString()} method returns the IPP string representation of + * the attribute value. * - * @author Alan Kaminsky + * @author Alan Kaminsky */ - public class JobState extends EnumSyntax implements PrintJobAttribute { + /** + * Use serialVersionUID from JDK 1.4 for interoperability. + */ private static final long serialVersionUID = 400465010094018920L; /** @@ -62,61 +65,57 @@ /** * The job is not a candidate for processing for any number of reasons but - * will return to the PENDING state as soon as the reasons are no longer - * present. The job's {@link JobStateReasons JobStateReasons} attribute must - * indicate why the job is no longer a candidate for processing. + * will return to the {@code PENDING} state as soon as the reasons are no + * longer present. The job's {@link JobStateReasons JobStateReasons} + * attribute must indicate why the job is no longer a candidate for + * processing. */ public static final JobState PENDING_HELD = new JobState(4); /** * The job is processing. One or more of the following activities is * occurring: - *

    - *
  1. - * The job is using, or is attempting to use, one or more purely software - * processes that are analyzing, creating, or interpreting a PDL, etc. - * - *
  2. - * The job is using, or is attempting to use, one or more hardware - * devices that are interpreting a PDL, making marks on a medium, and/or - * performing finishing, such as stapling, etc. - * - *
  3. - * The printer has made the job ready for printing, but the output - * device is not yet printing it, either because the job hasn't reached the - * output device or because the job is queued in the output device or some - * other spooler, awaiting the output device to print it. - *
- *

- * When the job is in the PROCESSING state, the entire job state includes - * the detailed status represented in the printer's {@link PrinterState - * PrinterState} and {@link PrinterStateReasons PrinterStateReasons} - * attributes. - *

+ *

    + *
  1. The job is using, or is attempting to use, one or more purely + * software processes that are analyzing, creating, or interpreting a PDL, + * etc. + *
  2. The job is using, or is attempting to use, one or more hardware + * devices that are interpreting a PDL, making marks on a medium, and/or + * performing finishing, such as stapling, etc. + *
  3. The printer has made the job ready for printing, but the output + * device is not yet printing it, either because the job hasn't reached + * the output device or because the job is queued in the output device or + * some other spooler, awaiting the output device to print it. + *
+ * When the job is in the {@code PROCESSING} state, the entire job state + * includes the detailed status represented in the printer's + * {@link PrinterState PrinterState} and + * {@link PrinterStateReasons PrinterStateReasons} attributes. + *

* Implementations may, though they need not, include additional values in * the job's {@link JobStateReasons JobStateReasons} attribute to indicate - * the progress of the job, such as adding the JOB_PRINTING value to + * the progress of the job, such as adding the {@code JOB_PRINTING} value to * indicate when the output device is actually making marks on paper and/or - * the PROCESSING_TO_STOP_POINT value to indicate that the printer is in the - * process of canceling or aborting the job. + * the {@code PROCESSING_TO_STOP_POINT} value to indicate that the printer + * is in the process of canceling or aborting the job. */ public static final JobState PROCESSING = new JobState (5); /** * The job has stopped while processing for any number of reasons and will - * return to the PROCESSING state as soon as the reasons are no longer - * present. - *

+ * return to the {@code PROCESSING} state as soon as the reasons are no + * longer present. + *

* The job's {@link JobStateReasons JobStateReasons} attribute may indicate * why the job has stopped processing. For example, if the output device is - * stopped, the PRINTER_STOPPED value may be included in the job's {@link - * JobStateReasons JobStateReasons} attribute. - *

- * Note: When an output device is stopped, the device usually + * stopped, the {@code PRINTER_STOPPED} value may be included in the job's + * {@link JobStateReasons JobStateReasons} attribute. + *

+ * Note: When an output device is stopped, the device usually * indicates its condition in human readable form locally at the device. A * client can obtain more complete device status remotely by querying the - * printer's {@link PrinterState PrinterState} and {@link - * PrinterStateReasons PrinterStateReasons} attributes. + * printer's {@link PrinterState PrinterState} and + * {@link PrinterStateReasons PrinterStateReasons} attributes. */ public static final JobState PROCESSING_STOPPED = new JobState (6); @@ -125,24 +124,27 @@ * canceling the job, and all job status attributes have reached their final * values for the job. While the printer is canceling the job, the job * remains in its current state, but the job's {@link JobStateReasons - * JobStateReasons} attribute should contain the PROCESSING_TO_STOP_POINT - * value and one of the CANCELED_BY_USER, CANCELED_BY_OPERATOR, or - * CANCELED_AT_DEVICE values. When the job moves to the CANCELED state, the - * PROCESSING_TO_STOP_POINT value, if present, must be removed, but the - * CANCELED_BY_xxx value, if present, must remain. + * JobStateReasons} attribute should contain the + * {@code PROCESSING_TO_STOP_POINT} value and one of the + * {@code CANCELED_BY_USER}, {@code CANCELED_BY_OPERATOR}, or + * {@code CANCELED_AT_DEVICE} values. When the job moves to the + * {@code CANCELED} state, the {@code PROCESSING_TO_STOP_POINT} value, if + * present, must be removed, but the CANCELED_BY_xxx value, if + * present, must remain. */ public static final JobState CANCELED = new JobState (7); /** * The job has been aborted by the system (usually while the job was in the - * PROCESSING or PROCESSING_STOPPED state), the printer has completed - * aborting the job, and all job status attributes have reached their final - * values for the job. While the printer is aborting the job, the job - * remains in its current state, but the job's {@link JobStateReasons - * JobStateReasons} attribute should contain the PROCESSING_TO_STOP_POINT - * and ABORTED_BY_SYSTEM values. When the job moves to the ABORTED state, - * the PROCESSING_TO_STOP_POINT value, if present, must be removed, but the - * ABORTED_BY_SYSTEM value, if present, must remain. + * {@code PROCESSING} or {@code PROCESSING_STOPPED} state), the printer has + * completed aborting the job, and all job status attributes have reached + * their final values for the job. While the printer is aborting the job, + * the job remains in its current state, but the job's + * {@link JobStateReasons JobStateReasons} attribute should contain the + * {@code PROCESSING_TO_STOP_POINT} and {@code ABORTED_BY_SYSTEM} values. + * When the job moves to the {@code ABORTED} state, the + * {@code PROCESSING_TO_STOP_POINT} value, if present, must be removed, but + * the {@code ABORTED_BY_SYSTEM} value, if present, must remain. */ public static final JobState ABORTED = new JobState (8); @@ -150,10 +152,10 @@ * The job has completed successfully or with warnings or errors after * processing, all of the job media sheets have been successfully stacked in * the appropriate output bin(s), and all job status attributes have reached - * their final values for the job. The job's {@link JobStateReasons - * JobStateReasons} attribute should contain one of these values: - * COMPLETED_SUCCESSFULLY, COMPLETED_WITH_WARNINGS, or - * COMPLETED_WITH_ERRORS. + * their final values for the job. The job's + * {@link JobStateReasons JobStateReasons} attribute should contain one of + * these values: {@code COMPLETED_SUCCESSFULLY}, + * {@code COMPLETED_WITH_WARNINGS}, or {@code COMPLETED_WITH_ERRORS}. */ public static final JobState COMPLETED = new JobState (9); @@ -162,12 +164,15 @@ /** * Construct a new job state enumeration value with the given integer value. * - * @param value Integer value. + * @param value Integer value */ protected JobState(int value) { super (value); } + /** + * The string table for class {@code JobState}. + */ private static final String[] myStringTable = {"unknown", null, @@ -180,6 +185,9 @@ "aborted", "completed"}; + /** + * The enumeration value table for class {@code JobState}. + */ private static final JobState[] myEnumValueTable = {UNKNOWN, null, @@ -193,14 +201,14 @@ COMPLETED}; /** - * Returns the string table for class JobState. + * Returns the string table for class {@code JobState}. */ protected String[] getStringTable() { return myStringTable; } /** - * Returns the enumeration value table for class JobState. + * Returns the enumeration value table for class {@code JobState}. */ protected EnumSyntax[] getEnumValueTable() { return myEnumValueTable; @@ -209,12 +217,12 @@ /** * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. - *

- * For class JobState and any vendor-defined subclasses, the category is - * class JobState itself. + *

+ * For class {@code JobState} and any vendor-defined subclasses, the + * category is class {@code JobState} 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 JobState.class; @@ -223,14 +231,13 @@ /** * Get the name of the category of which this attribute value is an * instance. - *

- * For class JobState and any vendor-defined subclasses, the category - * name is {@code "job-state"}. + *

+ * For class {@code JobState} and any vendor-defined subclasses, the + * category name is {@code "job-state"}. * - * @return Attribute category name. + * @return attribute category name */ public final String getName() { return "job-state"; } - }