PrinterState (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
class PrinterState

java.lang.Object
  javax.print.attribute.EnumSyntax
      javax.print.attribute.standard.PrinterState

All Implemented Interfaces:: Serializable, Cloneable, PrintServiceAttribute

Most common way to construct:

PrinterState IDLE = new PrinterState(0);

Based on 13 examples

public final class PrinterState
extends EnumSyntax
implements 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 {@link PrinterStateReasons 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.

Field Summary
`static PrinterState`	`IDLE` Indicates that new jobs can start processing without waiting.
`static PrinterState`	`PROCESSING` Indicates that jobs are processing; new jobs will wait before processing.
`static PrinterState`	`STOPPED` Indicates that no jobs can be processed and intervention is required.
`static PrinterState`	`UNKNOWN` The printer state is unknown.

Constructor Summary
`protected`	`PrinterState(int value)` Construct a new printer state enumeration value with the given integer value.

Method Summary
`Class`	`getCategory()` Get the printing attribute class which is to be used as the "category" for this printing attribute value.
`protected EnumSyntax[]`	`getEnumValueTable()` Returns the enumeration value table for class PrinterState.
`String`	`getName()` Get the name of the category of which this attribute value is an instance.
`protected String[]`	`getStringTable()` Returns the string table for class PrinterState.

Methods inherited from class javax.print.attribute.EnumSyntax
`clone, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

IDLE

public static final PrinterState IDLE

Indicates that new jobs can start processing without waiting.

PROCESSING

public static final PrinterState PROCESSING

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

STOPPED

public static final PrinterState STOPPED

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

UNKNOWN

public static final PrinterState UNKNOWN

The printer state is unknown.

Constructor Detail

PrinterState

protected PrinterState(int value)

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

Parameters:: value - Integer value.

Method Detail

getCategory

public final Class 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 {@link java.lang.Class java.lang.Class}.

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

Returns the enumeration value table for class PrinterState.

Overrides:: getEnumValueTable in class EnumSyntax

getName

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.

getStringTable

protected String[] getStringTable()

Returns the string table for class PrinterState.

Overrides:: getStringTable in class EnumSyntax