j4cups.protocol.enums

Enum JobStateReasons

java.lang.Object

java.lang.Enum<JobStateReasons>

j4cups.protocol.enums.JobStateReasons

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobStateReasons>

public enum JobStateReasons
extends java.lang.Enum<JobStateReasons>

This REQUIRED attribute provides additional information about the Job's current state. I.e., information that augments the value of the Job's "job-state" attribute.

These values MAY be used with any Job state or states for which the reason makes sense. Some of these value definitions indicate conformance requirements; the rest are OPTIONAL. Furthermore, when implemented, the Printer MUST return these values when the reason applies and MUST NOT return them when the reason no longer applies, whether the value of the Job's "job-state" attribute changed or not. When the Job does not have any reasons for being in its current state, the value of the Job's "job-state-reasons" attribute MUST be 'none'.

Since:

0.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
JOB_INCOMING Either (1) the Printer has accepted the Create-Job operation and is expecting additional Send-Document and/or Send-URI operations or (2) the Printer is retrieving/accepting Document data as a result of a Print-Job, Print-URI, Send-Document, or Send-URI operation.
NONE There are no reasons for the Job's current state.

Method Summary

Modifier and Type	Method and Description
static JobStateReasons	of(java.lang.String value) Maps the given string to the corresponding element.
java.lang.String	toString() This implementation generates the same representation as described in section RFC-8011 (section 5.3.8).
static JobStateReasons	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobStateReasons[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final JobStateReasons NONE

There are no reasons for the Job's current state. This state reason is semantically equivalent to "job-state-reasons" without any value and MUST be used when there is no other value, since the '1setOf' attribute syntax requires at least one value.

JOB_INCOMING

public static final JobStateReasons JOB_INCOMING

Either (1) the Printer has accepted the Create-Job operation and is expecting additional Send-Document and/or Send-URI operations or (2) the Printer is retrieving/accepting Document data as a result of a Print-Job, Print-URI, Send-Document, or Send-URI operation.

Method Detail

values

public static JobStateReasons[] 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 (JobStateReasons c : JobStateReasons.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobStateReasons valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

This implementation generates the same representation as described in section RFC-8011 (section 5.3.8).

Overrides:

toString in class java.lang.Enum<JobStateReasons>

Returns:

e.g. "job-incoming"

of

public static JobStateReasons of(java.lang.String value)

Maps the given string to the corresponding element. If it cannot be mapped NONE will be returned.

Parameters:

value - e.g. "job-incoming"

Returns:

e.g. JOB_INCOMING