Module java.desktop

Package javax.print.attribute.standard

Class QueuedJobCount

java.lang.Object

javax.print.attribute.IntegerSyntax

javax.print.attribute.standard.QueuedJobCount

All Implemented Interfaces:

Serializable, Cloneable, Attribute, PrintServiceAttribute

public final class QueuedJobCount
extends IntegerSyntax
implements PrintServiceAttribute

Class QueuedJobCount is an integer valued printing attribute that indicates the number of jobs in the printer whose JobState is either PENDING, PENDING_HELD, PROCESSING, or PROCESSING_STOPPED.

IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
QueuedJobCount(int value)	Construct a new queued job count attribute with the given integer value.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)	Returns whether this queued job count attribute is equivalent to the passed in object.
Class<? extends Attribute>	getCategory()	Get the printing attribute class which is to be used as the "category" for this printing attribute value.
String	getName()	Get the name of the category of which this attribute value is an instance.

Methods inherited from class javax.print.attribute.IntegerSyntax

getValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueuedJobCount

public QueuedJobCount(int value)

Construct a new queued job count attribute with the given integer value.

Parameters:

value - Integer value.

Throws:

IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.

Method Detail

equals

public boolean equals(Object object)

Returns whether this queued job count attribute is equivalent to the passed in object. To be equivalent, all of the following conditions mus be true:

1. object is not null.
2. object is an instance of class QueuedJobCount.
3. This queued job count attribute's value and object's value are equal.

Overrides:

equals in class IntegerSyntax

Parameters:

object - Object to compare to.

Returns:

True if object is equivalent to this queued job count attribute, false otherwise.

See Also:

Object.hashCode(), HashMap

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 QueuedJobCount, the category is class QueuedJobCount 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 QueuedJobCount, the category name is "queued-job-count".

Specified by:

getName in interface Attribute

Returns:

Attribute category name.