JobState (J4Cups 0.2.0 API)

java.lang.Object
- java.lang.Enum<JobState>
- - j4cups.protocol.enums.JobState

All Implemented Interfaces:

Serializable, Comparable<JobState>
```
public enum JobState
extends Enum<JobState>
```
The JobState describes the IPP Job Life Cycle. Normally, a Job progresses from left to right. Other state transitions are unlikely but are not forbidden. Not shown are the transitions to the 'canceled' state from the 'pending', 'pending-held', and 'processing-stopped' states.
```
 +----> canceled
 /
 +----> pending  -------> processing ---------+------> completed
 |         ^                   ^               \
 --->+     |                   |                +----> aborted
 |         v                   v               /
 +----> pending-held    processing-stopped ---+
 
```
Since:

0.2 (18.02.2018)

Author:

oboehm

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTED` The Job has been aborted by the system, usually while the Job was in the 'processing' or 'processing-stopped' state, and the Printer has completed aborting the Job; all Job Status attributes have reached their final values for the Job.
`CANCELED` The Job has been canceled by a Cancel-Job operation, and the Printer has completed canceling the Job.
`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.
`PENDING` The Job is a candidate to start processing but is not yet processing.
`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.
`PROCESSING` One or more of the following: (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, waiting for the Output Device to print it.
`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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getState()` Gets the represenation of the state as 32 bit integer.
`static JobState`	`of(int value)` Allows you to map a int value to the corresponding state.
`static JobState`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JobState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PENDING
```
public static final JobState PENDING
```
    The Job is a candidate to start processing but is not yet processing.
  - PENDING_HELD
```
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 "job-state-reasons" attribute MUST indicate why the Job is no longer a candidate for processing.
  - PROCESSING
```
public static final JobState PROCESSING
```
    One or more of the following: (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, waiting for 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 "printer-state", "printer-state-reasons", and "printer-state-message" attributes. Implementations MAY include additional values in the Job's "job-state- reasons" 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
```
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 "job-state-reasons" 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 "job-state- reasons" 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 "printer-state", "printer-state-reasons", and "printer-state-message" attributes.
  - CANCELED
```
public static final JobState CANCELED
```
    The Job has been canceled by a Cancel-Job operation, and the Printer has completed canceling the Job. 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 "job-state-reasons" 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 'canceled-by-xxx', if present, MUST remain.
  - ABORTED
```
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, and the Printer has completed aborting the Job; 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 "job-state-reasons" 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.
  - COMPLETED
```
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 "job-state-reasons" attribute SHOULD contain one of the 'completed-successfully', 'completed-with-warnings', or 'completed-with-errors' values.
- Method Detail
  - values
```
public static JobState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (JobState c : JobState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JobState valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getState
```
public int getState()
```
    Gets the represenation of the state as 32 bit integer.
    
    Returns:
    
    number between 3 and 9
  - of
```
public static JobState of(int value)
```
    Allows you to map a int value to the corresponding state.
    
    Parameters:
    
    value - e.g. 5
    
    Returns:
    
    operation, e.g. PROCESSING

Enum JobState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PENDING

PENDING_HELD

PROCESSING

PROCESSING_STOPPED

CANCELED

ABORTED

COMPLETED

Method Detail

values

valueOf

getState

of