Class PrinterState

java.lang.Object

javax.print.attribute.EnumSyntax

javax.print.attribute.standard.PrinterState

All Implemented Interfaces:

Serializable, Cloneable, Attribute, PrintServiceAttribute

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

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Class<? extends Attribute>	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.
final 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 declared in class EnumSyntax

clone, getOffset, getValue, hashCode, readResolve, toString

Modifier and Type	Method	Description
Object	clone()	Returns a clone of this enumeration value, which to preserve the semantics of enumeration values is the same object as this enumeration value.
protected int	getOffset()	Returns the lowest integer value used by this enumeration value's enumeration class.
int	getValue()	Returns this enumeration value's integer value.
int	hashCode()	Returns a hash code value for this enumeration value.
protected Object	readResolve()	During object input, convert this deserialized enumeration instance to the proper enumeration value defined in the enumeration attribute class.
String	toString()	Returns a string value corresponding to this enumeration value.

Methods declared in class Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

UNKNOWN

public static final PrinterState UNKNOWN

The printer state is unknown.

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.

Constructor Details

PrinterState

protected PrinterState(int value)

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

Parameters:

value - Integer value

Method Details

getStringTable

protected String[] getStringTable()

Returns the string table for class PrinterState.

Overrides:

getStringTable in class EnumSyntax

Returns:

the string table

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

Returns the enumeration value table for class PrinterState.

Overrides:

getEnumValueTable in class EnumSyntax

Returns:

the value table

getCategory

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.

Specified by:

getCategory in interface Attribute

Returns:

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

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

Specified by:

getName in interface Attribute

Returns:

attribute category name