- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.PrinterName
-
- All Implemented Interfaces:
- Serializable, Cloneable, Attribute, PrintServiceAttribute
public final class PrinterName extends TextSyntax implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description PrinterName(String printerName, Locale locale)
Constructs a new printer name attribute with the given name and locale.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object object)
Returns whether this printer name 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.
-
-
-
Constructor Detail
-
PrinterName
public PrinterName(String printerName, Locale locale)
Constructs a new printer name attribute with the given name and locale.- Parameters:
printerName
- Printer name.locale
- Natural language of the text string. null is interpreted to mean the default locale as returned byLocale.getDefault()
- Throws:
NullPointerException
- (unchecked exception) Thrown ifprinterName
is null.
-
-
Method Detail
-
equals
public boolean equals(Object object)
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.
- Overrides:
equals
in classTextSyntax
- Parameters:
object
- Object to compare to.- Returns:
- True if
object
is equivalent to this printer name 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 PrinterName, the category is class PrinterName itself.
- Specified by:
getCategory
in interfaceAttribute
- Returns:
- Printing attribute class (category), an instance of class
java.lang.Class
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/print/attribute/standard/printername.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.