| |
|
| java.lang.Object
 javax.print.attribute.TextSyntax
javax.print.attribute.standard.PrinterName
| PrinterName | | final public class PrinterName extends TextSyntax implements PrintServiceAttribute(Code) | | Class PrinterName is a printing attribute class, a text attribute, that
specifies the name of a printer. It is a name that is more end-user friendly
than a URI. An administrator determines a printer's name and sets this
attribute to that name. This name may be the last part of the printer's URI
or it may be unrelated. In non-US-English locales, a name may contain
characters that are not allowed in a URI.
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 |
| Constructor Summary | |
| public | PrinterName(String printerName, Locale locale)
Constructs a new printer name attribute with the given name and locale. |
| Method Summary | |
| public boolean | equals(Object object)
Returns whether this printer name attribute is equivalent to the passed
in object. | | final public Class<? extends Attribute> | getCategory()
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
For class PrinterName, the category is
class PrinterName itself. | | final public String | getName()
Get the name of the category of which this attribute value is an
instance. |
| PrinterName | | public PrinterName(String printerName, Locale locale)(Code) | | Constructs a new printer name attribute with the given name and locale.
Parameters:
printerName - Printer name.
Parameters:
locale - Natural language of the text string. nullis interpreted to mean the default locale as returnedby Locale.getDefault()
exception:
NullPointerException - (unchecked exception) Thrown if printerName is null. |
| equals | | public boolean equals(Object object)(Code) | | Returns whether this printer name attribute is equivalent to the passed
in object. To be equivalent, all of the following conditions must be
true:
-
object is not null.
-
object is an instance of class PrinterName.
-
This printer name attribute's underlying string and
object's underlying string are equal.
-
This printer name attribute's locale and
object's locale
are equal.
Parameters:
object - Object to compare to. True if object is equivalent to this printername attribute, false otherwise. |
| getCategory | | final public Class<? extends Attribute> getCategory()(Code) | | Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
For class PrinterName, the category is
class PrinterName itself.
Printing attribute class (category), an instance of classjava.lang.Class java.lang.Class. |
| getName | | final public String getName()(Code) | | Get the name of the category of which this attribute value is an
instance.
For class PrinterName, the category
name is "printer-name".
Attribute category name. |
|
|
|