- All Implemented Interfaces:
- Serializable,- Cloneable,- Attribute
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.
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final PrinterStateReasonThe 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).static final PrinterStateReasonOne or more covers on the device are open.static final PrinterStateReasonThe device is out of developer.static final PrinterStateReasonThe device is low on developer.static final PrinterStateReasonOne or more doors on the device are open.static final PrinterStateReasonThe fuser temperature is above normal.static final PrinterStateReasonThe fuser temperature is below normal.static final PrinterStateReasonOne or more input trays are not in the device.static final PrinterStateReasonOne or more interlock devices on the printer are unlocked.static final PrinterStateReasonAn interpreter resource is unavailable (e.g., font, form).static final PrinterStateReasonThe device is out of at least one marker supply (e.g. toner, ink, ribbon).static final PrinterStateReasonThe device is low on at least one marker supply (e.g. toner, ink, ribbon).static final PrinterStateReasonThe device marker supply waste receptacle is almost full.static final PrinterStateReasonThe device marker supply waste receptacle is full.static final PrinterStateReasonAt least one input tray is empty.static final PrinterStateReasonThe device has a media jam.static final PrinterStateReasonAt least one input tray is low on media.static final PrinterStateReasonA tray has run out of media.static final PrinterStateReasonSomeone has paused the printer, but the device(s) are taking an appreciable time to stop.static final PrinterStateReasonThe optical photo conductor is no longer functioning.static final PrinterStateReasonThe optical photo conductor is near end of life.static final PrinterStateReasonThe printer has detected an error other than ones listed below.static final PrinterStateReasonOne or more output areas are almost full (e.g. tray, stacker, collator).static final PrinterStateReasonOne or more output areas are full (e.g. tray, stacker, collator).static final PrinterStateReasonOne or more output trays are not in the device.static final PrinterStateReasonSomeone has paused the printer and the printer'sPrinterStateisSTOPPED.static final PrinterStateReasonSomeone has removed a printer from service, and the device may be powered down or physically removed.static final PrinterStateReasonThe limit of persistent storage allocated for spooling has been reached.static final PrinterStateReasonWhen a printer controls more than one output device, this reason indicates that one or more output devices are stopped.static final PrinterStateReasonThe printer is in the process of stopping the device and will be stopped in a while.static final PrinterStateReasonThe server was able to connect to the output device (or is always connected), but was unable to get a response from the output device.static final PrinterStateReasonThe device is out of toner.static final PrinterStateReasonThe device is low on toner.
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedPrinterStateReason(int value) Construct a new printer state reason enumeration value with the given integer value.
- 
Method SummaryModifier and TypeMethodDescriptionGet the printing attribute class which is to be used as the "category" for this printing attribute value.protected EnumSyntax[]Returns the enumeration value table for classPrinterStateReason.final StringgetName()Get the name of the category of which this attribute value is an instance.protected String[]Returns the string table for classPrinterStateReason.Methods declared in class javax.print.attribute.EnumSyntaxclone, getOffset, getValue, hashCode, readResolve, toString
- 
Field Details- 
OTHERThe printer has detected an error other than ones listed below.
- 
MEDIA_NEEDEDA tray has run out of media.
- 
MEDIA_JAMThe device has a media jam.
- 
MOVING_TO_PAUSEDSomeone has paused the printer, but the device(s) are taking an appreciable time to stop. Later, when all output has stopped, thePrinterStatebecomesSTOPPED, and thePAUSEDvalue replaces theMOVING_TO_PAUSEDvalue in thePrinterStateReasonsattribute. This value must be supported if the printer can be paused and the implementation takes significant time to pause a device in certain circumstances.
- 
PAUSEDSomeone has paused the printer and the printer'sPrinterStateisSTOPPED. 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, thePrintermust 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.
- 
SHUTDOWNSomeone 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.
- 
CONNECTING_TO_DEVICEThe 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).
- 
TIMED_OUTThe server was able to connect to the output device (or is always connected), but was unable to get a response from the output device.
- 
STOPPINGThe 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 thePrinterStatetoSTOPPED. TheSTOPPINGreason is never an error, even for a printer with a single output device. When an output device ceases accepting jobs, the printer'sPrinterStateReasonswill have this reason while the output device completes printing.
- 
STOPPED_PARTLYWhen 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.
- 
TONER_LOWThe device is low on toner.
- 
TONER_EMPTYThe device is out of toner.
- 
SPOOL_AREA_FULLThe 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.
- 
COVER_OPENOne or more covers on the device are open.
- 
INTERLOCK_OPENOne or more interlock devices on the printer are unlocked.
- 
DOOR_OPENOne or more doors on the device are open.
- 
INPUT_TRAY_MISSINGOne or more input trays are not in the device.
- 
MEDIA_LOWAt least one input tray is low on media.
- 
MEDIA_EMPTYAt least one input tray is empty.
- 
OUTPUT_TRAY_MISSINGOne or more output trays are not in the device.
- 
OUTPUT_AREA_ALMOST_FULLOne or more output areas are almost full (e.g. tray, stacker, collator).
- 
OUTPUT_AREA_FULLOne or more output areas are full (e.g. tray, stacker, collator).
- 
MARKER_SUPPLY_LOWThe device is low on at least one marker supply (e.g. toner, ink, ribbon).
- 
MARKER_SUPPLY_EMPTYThe device is out of at least one marker supply (e.g. toner, ink, ribbon).
- 
MARKER_WASTE_ALMOST_FULLThe device marker supply waste receptacle is almost full.
- 
MARKER_WASTE_FULLThe device marker supply waste receptacle is full.
- 
FUSER_OVER_TEMPThe fuser temperature is above normal.
- 
FUSER_UNDER_TEMPThe fuser temperature is below normal.
- 
OPC_NEAR_EOLThe optical photo conductor is near end of life.
- 
OPC_LIFE_OVERThe optical photo conductor is no longer functioning.
- 
DEVELOPER_LOWThe device is low on developer.
- 
DEVELOPER_EMPTYThe device is out of developer.
- 
INTERPRETER_RESOURCE_UNAVAILABLEAn interpreter resource is unavailable (e.g., font, form).
 
- 
- 
Constructor Details- 
PrinterStateReasonprotected PrinterStateReason(int value) Construct a new printer state reason enumeration value with the given integer value.- Parameters:
- value- Integer value
 
 
- 
- 
Method Details- 
getStringTableReturns the string table for classPrinterStateReason.- Overrides:
- getStringTablein class- EnumSyntax
- Returns:
- the string table
 
- 
getEnumValueTableReturns the enumeration value table for classPrinterStateReason.- Overrides:
- getEnumValueTablein class- EnumSyntax
- Returns:
- the value table
 
- 
getCategoryGet the printing attribute class which is to be used as the "category" for this printing attribute value.For class PrinterStateReasonand any vendor-defined subclasses, the category is classPrinterStateReasonitself.- Specified by:
- getCategoryin interface- Attribute
- Returns:
- printing attribute class (category), an instance of class
         java.lang.Class
 
- 
getNameGet the name of the category of which this attribute value is an instance.For class PrinterStateReasonand any vendor-defined subclasses, the category name is"printer-state-reason".
 
-