Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class PrinterState

extends EnumSyntax
implements PrintServiceAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintServiceAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, javax.print.attribute.Attribute, .EnumSyntax, .PrintServiceAttribute

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.

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
public static final PrinterState
IDLE

Indicates that new jobs can start processing without waiting.

private static final PrinterState[]
myEnumValueTable

The enumeration value table for class PrinterState.

private static final String[]
myStringTable

The string table for class PrinterState.

public static final PrinterState
PROCESSING

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

private static final long
serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.
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.

Constructor Summary

AccessConstructor and Description
protected
PrinterState(int
Integer value
value
)

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

Method Summary

Modifier and TypeMethod 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 PrinterState.

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 PrinterState.

Inherited from javax.print.attribute.EnumSyntax:
clonegetOffsetgetValuehashCodereadResolvetoString

Field Detail

IDLEback to summary
public static final PrinterState IDLE

Indicates that new jobs can start processing without waiting.

myEnumValueTableback to summary
private static final PrinterState[] myEnumValueTable

The enumeration value table for class PrinterState.

myStringTableback to summary
private static final String[] myStringTable

The string table for class PrinterState.

PROCESSINGback to summary
public static final PrinterState PROCESSING

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.EnumSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial
STOPPEDback to summary
public static final PrinterState STOPPED

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

UNKNOWNback to summary
public static final PrinterState UNKNOWN

The printer state is unknown.

Constructor Detail

PrinterStateback to summary
protected PrinterState(int value)

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

Parameters
value:int

Integer value

Method Detail

getCategoryback 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 PrinterState, the category is class PrinterState itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

getEnumValueTableback to summary
protected EnumSyntax[] getEnumValueTable()

Overrides javax.print.attribute.EnumSyntax.getEnumValueTable.

Returns the enumeration value table for class PrinterState.

Returns:EnumSyntax[]

Doc from javax.print.attribute.EnumSyntax.getEnumValueTable.

the value table

getNameback 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 PrinterState, the category name is "printer-state".

Returns:String

attribute category name

getStringTableback to summary
protected String[] getStringTable()

Overrides javax.print.attribute.EnumSyntax.getStringTable.

Returns the string table for class PrinterState.

Returns:String[]

Doc from javax.print.attribute.EnumSyntax.getStringTable.

the string table