OpenJDK 27 · javax.print.attribute.standard.JobState

Field Summary

Modifier and Type	Field and Description
public static final JobState	ABORTED 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.
public static final JobState	CANCELED The job has been canceled by some human agency, the printer has completed canceling the job, and all job status attributes have reached their final values for the job.
public static final JobState	COMPLETED 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.
private static final JobState[]	myEnumValueTable The enumeration value table for class `JobState`.
private static final String[]	myStringTable The string table for class `JobState`.
public static final JobState	PENDING The job is a candidate to start processing, but is not yet processing.
public static final JobState	PENDING_HELD 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.
public static final JobState	PROCESSING The job is processing.
public static final JobState	PROCESSING_STOPPED 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.
private static final long	serialVersionUID Hides javax.print.attribute.EnumSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.
public static final JobState	UNKNOWN The job state is unknown.

Access	Constructor and Description
protected	JobState(int Integer value value) Construct a new job state enumeration value with the given integer value.

Method Summary

Modifier and Type	Method and Description
public final Class<? extends Attribute>	Returns: printing attribute class (category), an instance of class `java.lang.Class` getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
protected EnumSyntax[]	getEnumValueTable() Overrides javax.print.attribute.EnumSyntax.getEnumValueTable. Returns the enumeration value table for class `JobState`.
public final String	Returns: attribute category name getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance.
protected String[]	getStringTable() Overrides javax.print.attribute.EnumSyntax.getStringTable. Returns the string table for class `JobState`.

Inherited from javax.print.attribute.EnumSyntax:: clone getOffset getValue hashCode readResolve toString

Field Detail

ABORTED back to summary

ABORTED	back to summary
public static final JobState ABORTED 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 `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.

public static final JobState ABORTED

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 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.

CANCELED back to summary

CANCELED	back to summary
public static final JobState CANCELED The job has been canceled by some human agency, the printer has completed 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 `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.

public static final JobState CANCELED

The job has been canceled by some human agency, the printer has completed 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 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.

COMPLETED back to summary

COMPLETED	back to summary
public static final JobState COMPLETED 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 `JobStateReasons` attribute should contain one of these values: `COMPLETED_SUCCESSFULLY`, `COMPLETED_WITH_WARNINGS`, or `COMPLETED_WITH_ERRORS`.

public static final JobState COMPLETED

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 JobStateReasons attribute should contain one of these values: COMPLETED_SUCCESSFULLY, COMPLETED_WITH_WARNINGS, or COMPLETED_WITH_ERRORS.

myEnumValueTable	back to summary
private static final JobState[] myEnumValueTable The enumeration value table for class `JobState`.

myStringTable	back to summary
private static final String[] myStringTable The string table for class `JobState`.

PENDING	back to summary
public static final JobState PENDING The job is a candidate to start processing, but is not yet processing.

PENDING_HELD	back to summary
public static final JobState PENDING_HELD 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 `JobStateReasons` attribute must indicate why the job is no longer a candidate for processing.

PROCESSING back to summary

PROCESSING	back to summary
public static final JobState PROCESSING The job is processing. One or more of the following activities is occurring: The job is using, or is attempting to use, one or more purely software processes that are analyzing, creating, or interpreting a PDL, etc. 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. 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 `PrinterState` and `PrinterStateReasons` attributes. Implementations may, though they need not, include additional values in the job's `JobStateReasons` attribute to indicate the progress of the job, such as adding the `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.

public static final JobState PROCESSING

The job is processing. One or more of the following activities is occurring:

The job is using, or is attempting to use, one or more purely software processes that are analyzing, creating, or interpreting a PDL, etc.
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.
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 PrinterState and PrinterStateReasons attributes.

Implementations may, though they need not, include additional values in the job's JobStateReasons attribute to indicate the progress of the job, such as adding the 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.

PROCESSING_STOPPED back to summary

PROCESSING_STOPPED	back to summary
public static final JobState PROCESSING_STOPPED 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. The job's `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 `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 `PrinterState` and `PrinterStateReasons` attributes.

public static final JobState PROCESSING_STOPPED

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.

The job's 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 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 PrinterState and PrinterStateReasons attributes.

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.EnumSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

UNKNOWN	back to summary
public static final JobState UNKNOWN The job state is unknown.

Constructor Detail

JobState	back to summary
protected JobState(int value) Construct a new job state enumeration value with the given integer value. Parameters value:int Integer value

JobState

back to summary

protected JobState(int value)

Construct a new job state enumeration value with the given integer value.

Parameters

value:int: Integer value

Method Detail

getCategory back to summary

getCategory	back to summary
public final Class<? extends Attribute> getCategory() Implements javax.print.attribute.Attribute.getCategory. 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. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.getCategory.

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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations

@Override

getEnumValueTable back to summary

getEnumValueTable	back to summary
protected EnumSyntax[] getEnumValueTable() Overrides javax.print.attribute.EnumSyntax.getEnumValueTable. Returns the enumeration value table for class `JobState`. Annotations @Override

protected EnumSyntax[] getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class JobState.

Annotations

@Override

getName back to summary

getName	back to summary
public final String getName() Implements javax.print.attribute.Attribute.getName. 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 `"job-state"`. Returns:String attribute category name Annotations @Override

public final String getName()

Implements javax.print.attribute.Attribute.getName.

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 "job-state".

Returns:String

attribute category name

Annotations

@Override

getStringTable back to summary

getStringTable	back to summary
protected String[] getStringTable() Overrides javax.print.attribute.EnumSyntax.getStringTable. Returns the string table for class `JobState`. Annotations @Override

protected String[] getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class JobState.

Annotations

@Override

public Class JobState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail