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

Class PrinterStateReason is a printing attribute class, an enumeration, that provides additional information about the printer's current state, i.e., information that augments the value of the printer's PrinterState attribute. Class PrinterStateReason defines standard printer state reason values. A Print Service implementation only needs to report those printer state reasons which are appropriate for the particular implementation; it does not have to report every defined printer state reason.

Instances of PrinterStateReason do not appear in a Print Service's attribute set directly. Rather, a PrinterStateReasons attribute appears in the Print Service's attribute set. The PrinterStateReasons attribute contains zero, one, or more than one PrinterStateReason objects which pertain to the Print Service's status, and each PrinterStateReason object is associated with a Severity level of REPORT (least severe), WARNING, or ERROR (most severe). The printer adds a PrinterStateReason object to the Print Service's PrinterStateReasons attribute when the corresponding condition becomes true of the printer, and the printer removes the PrinterStateReason object again when the corresponding condition becomes false, regardless of whether the Print Service's overall PrinterState also changed.

IPP Compatibility: The string values returned by each individual PrinterStateReason and associated Severity object's toString() methods, concatenated together with a hyphen ("-") in between, gives the IPP keyword value for a PrinterStateReasons. The category name returned by getName() gives the IPP attribute name.

Field Summary

Modifier and Type	Field and Description
public static final PrinterStateReason	CONNECTING_TO_DEVICE The printer has scheduled a job on the output device and is in the process of connecting to a shared network output device (and might not be able to actually start printing the job for an arbitrarily long time depending on the usage of the output device by other servers on the network).
public static final PrinterStateReason	COVER_OPEN One or more covers on the device are open.
public static final PrinterStateReason	DEVELOPER_EMPTY The device is out of developer.
public static final PrinterStateReason	DEVELOPER_LOW The device is low on developer.
public static final PrinterStateReason	DOOR_OPEN One or more doors on the device are open.
public static final PrinterStateReason	FUSER_OVER_TEMP The fuser temperature is above normal.
public static final PrinterStateReason	FUSER_UNDER_TEMP The fuser temperature is below normal.
public static final PrinterStateReason	INPUT_TRAY_MISSING One or more input trays are not in the device.
public static final PrinterStateReason	INTERLOCK_OPEN One or more interlock devices on the printer are unlocked.
public static final PrinterStateReason	INTERPRETER_RESOURCE_UNAVAILABLE An interpreter resource is unavailable (e.g., font, form).
public static final PrinterStateReason	MARKER_SUPPLY_EMPTY The device is out of at least one marker supply (e.g. toner, ink, ribbon).
public static final PrinterStateReason	MARKER_SUPPLY_LOW The device is low on at least one marker supply (e.g. toner, ink, ribbon).
public static final PrinterStateReason	MARKER_WASTE_ALMOST_FULL The device marker supply waste receptacle is almost full.
public static final PrinterStateReason	MARKER_WASTE_FULL The device marker supply waste receptacle is full.
public static final PrinterStateReason	MEDIA_EMPTY At least one input tray is empty.
public static final PrinterStateReason	MEDIA_JAM The device has a media jam.
public static final PrinterStateReason	MEDIA_LOW At least one input tray is low on media.
public static final PrinterStateReason	MEDIA_NEEDED A tray has run out of media.
public static final PrinterStateReason	MOVING_TO_PAUSED Someone has paused the printer, but the device(s) are taking an appreciable time to stop.
private static final PrinterStateReason[]	myEnumValueTable The enumeration value table for class `PrinterStateReason`.
private static final String[]	myStringTable The string table for class `PrinterStateReason`.
public static final PrinterStateReason	OPC_LIFE_OVER The optical photo conductor is no longer functioning.
public static final PrinterStateReason	OPC_NEAR_EOL The optical photo conductor is near end of life.
public static final PrinterStateReason	OTHER The printer has detected an error other than ones listed below.
public static final PrinterStateReason	OUTPUT_AREA_ALMOST_FULL One or more output areas are almost full (e.g. tray, stacker, collator).
public static final PrinterStateReason	OUTPUT_AREA_FULL One or more output areas are full (e.g. tray, stacker, collator).
public static final PrinterStateReason	OUTPUT_TRAY_MISSING One or more output trays are not in the device.
public static final PrinterStateReason	PAUSED Someone has paused the printer and the printer's `PrinterState` is `STOPPED`.
private static final long	serialVersionUID Hides javax.print.attribute.EnumSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.
public static final PrinterStateReason	SHUTDOWN Someone has removed a printer from service, and the device may be powered down or physically removed.
public static final PrinterStateReason	SPOOL_AREA_FULL The limit of persistent storage allocated for spooling has been reached.
public static final PrinterStateReason	STOPPED_PARTLY When a printer controls more than one output device, this reason indicates that one or more output devices are stopped.
public static final PrinterStateReason	STOPPING The printer is in the process of stopping the device and will be stopped in a while.
public static final PrinterStateReason	TIMED_OUT The server was able to connect to the output device (or is always connected), but was unable to get a response from the output device.
public static final PrinterStateReason	TONER_EMPTY The device is out of toner.
public static final PrinterStateReason	TONER_LOW The device is low on toner.

Access	Constructor and Description
protected	PrinterStateReason(int Integer value value) Construct a new printer state reason 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 `PrinterStateReason`.
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 `PrinterStateReason`.

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

Field Detail

CONNECTING_TO_DEVICE	back to summary
public static final PrinterStateReason CONNECTING_TO_DEVICE The printer has scheduled a job on the output device and is in the process of connecting to a shared network output device (and might not be able to actually start printing the job for an arbitrarily long time depending on the usage of the output device by other servers on the network).

COVER_OPEN	back to summary
public static final PrinterStateReason COVER_OPEN One or more covers on the device are open.

DEVELOPER_EMPTY	back to summary
public static final PrinterStateReason DEVELOPER_EMPTY The device is out of developer.

DEVELOPER_LOW	back to summary
public static final PrinterStateReason DEVELOPER_LOW The device is low on developer.

DOOR_OPEN	back to summary
public static final PrinterStateReason DOOR_OPEN One or more doors on the device are open.

FUSER_OVER_TEMP	back to summary
public static final PrinterStateReason FUSER_OVER_TEMP The fuser temperature is above normal.

FUSER_UNDER_TEMP	back to summary
public static final PrinterStateReason FUSER_UNDER_TEMP The fuser temperature is below normal.

INPUT_TRAY_MISSING	back to summary
public static final PrinterStateReason INPUT_TRAY_MISSING One or more input trays are not in the device.

INTERLOCK_OPEN	back to summary
public static final PrinterStateReason INTERLOCK_OPEN One or more interlock devices on the printer are unlocked.

INTERPRETER_RESOURCE_UNAVAILABLE	back to summary
public static final PrinterStateReason INTERPRETER_RESOURCE_UNAVAILABLE An interpreter resource is unavailable (e.g., font, form).

MARKER_SUPPLY_EMPTY	back to summary
public static final PrinterStateReason MARKER_SUPPLY_EMPTY The device is out of at least one marker supply (e.g. toner, ink, ribbon).

MARKER_SUPPLY_LOW	back to summary
public static final PrinterStateReason MARKER_SUPPLY_LOW The device is low on at least one marker supply (e.g. toner, ink, ribbon).

MARKER_WASTE_ALMOST_FULL	back to summary
public static final PrinterStateReason MARKER_WASTE_ALMOST_FULL The device marker supply waste receptacle is almost full.

MARKER_WASTE_FULL	back to summary
public static final PrinterStateReason MARKER_WASTE_FULL The device marker supply waste receptacle is full.

MEDIA_EMPTY	back to summary
public static final PrinterStateReason MEDIA_EMPTY At least one input tray is empty.

MEDIA_JAM	back to summary
public static final PrinterStateReason MEDIA_JAM The device has a media jam.

MEDIA_LOW	back to summary
public static final PrinterStateReason MEDIA_LOW At least one input tray is low on media.

MEDIA_NEEDED	back to summary
public static final PrinterStateReason MEDIA_NEEDED A tray has run out of media.

MOVING_TO_PAUSED back to summary

MOVING_TO_PAUSED	back to summary
public static final PrinterStateReason MOVING_TO_PAUSED Someone has paused the printer, but the device(s) are taking an appreciable time to stop. Later, when all output has stopped, the `PrinterState` becomes `STOPPED`, and the `PAUSED` value replaces the `MOVING_TO_PAUSED` value in the `PrinterStateReasons` attribute. This value must be supported if the printer can be paused and the implementation takes significant time to pause a device in certain circumstances.

public static final PrinterStateReason MOVING_TO_PAUSED

Someone has paused the printer, but the device(s) are taking an appreciable time to stop. Later, when all output has stopped, the PrinterState becomes STOPPED, and the PAUSED value replaces the MOVING_TO_PAUSED value in the PrinterStateReasons attribute. This value must be supported if the printer can be paused and the implementation takes significant time to pause a device in certain circumstances.

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

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

OPC_LIFE_OVER	back to summary
public static final PrinterStateReason OPC_LIFE_OVER The optical photo conductor is no longer functioning.

OPC_NEAR_EOL	back to summary
public static final PrinterStateReason OPC_NEAR_EOL The optical photo conductor is near end of life.

OTHER	back to summary
public static final PrinterStateReason OTHER The printer has detected an error other than ones listed below.

OUTPUT_AREA_ALMOST_FULL	back to summary
public static final PrinterStateReason OUTPUT_AREA_ALMOST_FULL One or more output areas are almost full (e.g. tray, stacker, collator).

OUTPUT_AREA_FULL	back to summary
public static final PrinterStateReason OUTPUT_AREA_FULL One or more output areas are full (e.g. tray, stacker, collator).

OUTPUT_TRAY_MISSING	back to summary
public static final PrinterStateReason OUTPUT_TRAY_MISSING One or more output trays are not in the device.

PAUSED back to summary

PAUSED	back to summary
public static final PrinterStateReason PAUSED Someone has paused the printer and the printer's `PrinterState` is `STOPPED`. In this state, a printer must not produce printed output, but it must perform other operations requested by a client. If a printer had been printing a job when the printer was paused, the `Printer` must resume printing that job when the printer is no longer paused and leave no evidence in the printed output of such a pause. This value must be supported if the printer can be paused.

public static final PrinterStateReason PAUSED

Someone has paused the printer and the printer's PrinterState is STOPPED. In this state, a printer must not produce printed output, but it must perform other operations requested by a client. If a printer had been printing a job when the printer was paused, the Printer must resume printing that job when the printer is no longer paused and leave no evidence in the printed output of such a pause. This value must be supported if the printer can be paused.

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

SHUTDOWN	back to summary
public static final PrinterStateReason SHUTDOWN Someone has removed a printer from service, and the device may be powered down or physically removed. In this state, a printer must not produce printed output, and unless the printer is realized by a print server that is still active, the printer must perform no other operations requested by a client. If a printer had been printing a job when it was shut down, the printer need not resume printing that job when the printer is no longer shut down. If the printer resumes printing such a job, it may leave evidence in the printed output of such a shutdown, e.g. the part printed before the shutdown may be printed a second time after the shutdown.

SHUTDOWN

back to summary

public static final PrinterStateReason SHUTDOWN

Someone has removed a printer from service, and the device may be powered down or physically removed. In this state, a printer must not produce printed output, and unless the printer is realized by a print server that is still active, the printer must perform no other operations requested by a client. If a printer had been printing a job when it was shut down, the printer need not resume printing that job when the printer is no longer shut down. If the printer resumes printing such a job, it may leave evidence in the printed output of such a shutdown, e.g. the part printed before the shutdown may be printed a second time after the shutdown.

SPOOL_AREA_FULL	back to summary
public static final PrinterStateReason SPOOL_AREA_FULL The limit of persistent storage allocated for spooling has been reached. The printer is temporarily unable to accept more jobs. The printer will remove this reason when it is able to accept more jobs. This value should be used by a non-spooling printer that only accepts one or a small number jobs at a time or a spooling printer that has filled the spool space.

SPOOL_AREA_FULL

back to summary

public static final PrinterStateReason SPOOL_AREA_FULL

The limit of persistent storage allocated for spooling has been reached. The printer is temporarily unable to accept more jobs. The printer will remove this reason when it is able to accept more jobs. This value should be used by a non-spooling printer that only accepts one or a small number jobs at a time or a spooling printer that has filled the spool space.

STOPPED_PARTLY	back to summary
public static final PrinterStateReason STOPPED_PARTLY When a printer controls more than one output device, this reason indicates that one or more output devices are stopped. If the reason's severity is a report, fewer than half of the output devices are stopped. If the reason's severity is a warning, half or more but fewer than all of the output devices are stopped.

STOPPING back to summary

STOPPING	back to summary
public static final PrinterStateReason STOPPING The printer is in the process of stopping the device and will be stopped in a while. When the device is stopped, the printer will change the `PrinterState` to `STOPPED`. The `STOPPING` reason is never an error, even for a printer with a single output device. When an output device ceases accepting jobs, the printer's `PrinterStateReasons` will have this reason while the output device completes printing.

public static final PrinterStateReason STOPPING

The printer is in the process of stopping the device and will be stopped in a while. When the device is stopped, the printer will change the PrinterState to STOPPED. The STOPPING reason is never an error, even for a printer with a single output device. When an output device ceases accepting jobs, the printer's PrinterStateReasons will have this reason while the output device completes printing.

TIMED_OUT	back to summary
public static final PrinterStateReason TIMED_OUT The server was able to connect to the output device (or is always connected), but was unable to get a response from the output device.

TONER_EMPTY	back to summary
public static final PrinterStateReason TONER_EMPTY The device is out of toner.

TONER_LOW	back to summary
public static final PrinterStateReason TONER_LOW The device is low on toner.

Constructor Detail

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

PrinterStateReason

back to summary

protected PrinterStateReason(int value)

Construct a new printer state reason 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 `PrinterStateReason` and any vendor-defined subclasses, the category is class `PrinterStateReason` 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 PrinterStateReason and any vendor-defined subclasses, the category is class PrinterStateReason 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 `PrinterStateReason`. Annotations @Override

protected EnumSyntax[] getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class PrinterStateReason.

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 `PrinterStateReason` and any vendor-defined subclasses, the category name is `"printer-state-reason"`. 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 PrinterStateReason and any vendor-defined subclasses, the category name is "printer-state-reason".

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 `PrinterStateReason`. Annotations @Override

protected String[] getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class PrinterStateReason.

Annotations

@Override

public Class PrinterStateReason

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail