public final class

PrinterState

extends EnumSyntax
implements PrintServiceAttribute
java.lang.Object
   ↳ javax.print.attribute.EnumSyntax
     ↳ javax.print.attribute.standard.PrinterState

Class Overview

Class PrinterState is a printing attribute class, an enumeration, that identifies the current state of a printer. Class PrinterState defines standard printer state values. A Print Service implementation only needs to report those printer states which are appropriate for the particular implementation; it does not have to report every defined printer state. The PrinterStateReasons attribute augments the PrinterState attribute to give more detailed information about the printer in given printer state.

IPP Compatibility: The category name returned by getName() is the IPP attribute name. The enumeration's integer value is the IPP enum value. The toString() method returns the IPP string representation of the attribute value.

Summary

Fields
public static final PrinterState IDLE Indicates that new jobs can start processing without waiting.
public static final PrinterState PROCESSING Indicates that jobs are processing; new jobs will wait before processing.
public static final PrinterState STOPPED Indicates that no jobs can be processed and intervention is required.
public static final PrinterState UNKNOWN The printer state is unknown.
Protected Constructors
PrinterState(int value)
Construct a new printer state enumeration value with the given integer value.
Public Methods
final Class<? extends Attribute> getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
final String getName()
Get the name of the category of which this attribute value is an instance.
Protected Methods
EnumSyntax[] getEnumValueTable()
Returns the enumeration value table for class PrinterState.
String[] getStringTable()
Returns the string table for class PrinterState.
[Expand]
Inherited Methods
From class javax.print.attribute.EnumSyntax
From class java.lang.Object
From interface javax.print.attribute.Attribute

Fields

public static final PrinterState IDLE

Indicates that new jobs can start processing without waiting.

public static final PrinterState PROCESSING

Indicates that jobs are processing; new jobs will wait before processing.

public static final PrinterState STOPPED

Indicates that no jobs can be processed and intervention is required.

public static final PrinterState UNKNOWN

The printer state is unknown.

Protected Constructors

protected PrinterState (int value)

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

Parameters
value Integer value.

Public Methods

public final Class<? extends Attribute> getCategory ()

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class PrinterState, the category is class PrinterState itself.

Returns
  • Printing attribute class (category), an instance of class java.lang.Class.

public final String getName ()

Get the name of the category of which this attribute value is an instance.

For class PrinterState, the category name is "printer-state".

Returns
  • Attribute category name.

Protected Methods

protected EnumSyntax[] getEnumValueTable ()

Returns the enumeration value table for class PrinterState.

Returns
  • the value table

protected String[] getStringTable ()

Returns the string table for class PrinterState.

Returns
  • the string table