java.lang.Object
javax.print.attribute.TextSyntax
javax.print.attribute.standard.PrinterName
- All Implemented Interfaces:
Serializable
,Cloneable
,Attribute
,PrintServiceAttribute
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.
- See Also:
-
Constructor Summary
ConstructorDescriptionPrinterName
(String printerName, Locale locale) Constructs a new printer name attribute with the given name and locale. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether this printer name attribute is equivalent to the passed in object.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.Methods declared in class javax.print.attribute.TextSyntax
getLocale, getValue, hashCode, toString
-
Constructor Details
-
PrinterName
Constructs a new printer name attribute with the given name and locale.- Parameters:
printerName
- printer namelocale
- natural language of the text string.null
is interpreted to mean the default locale as returned byLocale.getDefault()
- Throws:
NullPointerException
- ifprinterName
isnull
-
-
Method Details
-
equals
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 notnull
.object
is an instance of classPrinterName
.- 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.
- Overrides:
equals
in classTextSyntax
- Parameters:
object
-Object
to compare to- Returns:
true
ifobject
is equivalent to this printer name attribute,false
otherwise- See Also:
-
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 classPrinterName
itself.- Specified by:
getCategory
in interfaceAttribute
- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
getName
Get the name of the category of which this attribute value is an instance.For class
PrinterName
, the category name is"printer-name"
.
-