FileDocCategorySizeDatePackage
PrinterInfo.javaAPI DocJava SE 6 API3470Tue Jun 10 00:26:24 BST 2008javax.print.attribute.standard

PrinterInfo

public final class PrinterInfo extends TextSyntax implements PrintServiceAttribute
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.

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public PrinterInfo(String info, Locale locale)
Constructs a new printer info attribute with the given information string and locale.

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


                                                                      
         
	super (info, locale);
    
Methods Summary
public booleanequals(java.lang.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.

param
object Object to compare to.
return
True if object is equivalent to this printer info attribute, false otherwise.

	return (super.equals(object) && object instanceof PrinterInfo);
    
public final java.lang.ClassgetCategory()
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.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return PrinterInfo.class;
    
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class PrinterInfo, the category name is "printer-info".

return
Attribute category name.

	return "printer-info";