public final class

PrinterInfo

extends TextSyntax
implements PrintServiceAttribute
java.lang.Object
   ↳ javax.print.attribute.TextSyntax
     ↳ javax.print.attribute.standard.PrinterInfo

Class Overview

Class PrinterInfo is a printing attribute class, a text attribute, that provides descriptive information about a printer. This could include things like: "This printer can be used for printing color transparencies for HR presentations", or "Out of courtesy for others, please print only small (1-5 page) jobs at this printer", or even \ "This printer is going away on July 1, 1997, please find a new printer".

IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by getName() gives the IPP attribute name.

Summary

Public Constructors
PrinterInfo(String info, Locale locale)
Constructs a new printer info attribute with the given information string and locale.
Public Methods
boolean equals(Object object)
Returns whether this printer info attribute is equivalent to the passed in object.
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.
[Expand]
Inherited Methods
From class javax.print.attribute.TextSyntax
From class java.lang.Object
From interface javax.print.attribute.Attribute

Public Constructors

public PrinterInfo (String info, Locale locale)

Constructs a new printer info attribute with the given information string and locale.

Parameters
info Printer information string.
locale Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
Throws
NullPointerException (unchecked exception) Thrown if info is null.

Public Methods

public boolean equals (Object object)

Returns whether this printer info attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

  1. object is not null.
  2. object is an instance of class PrinterInfo.
  3. This printer info attribute's underlying string and object's underlying string are equal.
  4. This printer info attribute's locale and object's locale are equal.

Parameters
object Object to compare to.
Returns
  • True if object is equivalent to this printer info attribute, false otherwise.

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 PrinterInfo, the category is class PrinterInfo 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 PrinterInfo, the category name is "printer-info".

Returns
  • Attribute category name.