APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class PrinterName

extends TextSyntax
implements PrintServiceAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintServiceAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, java.util.Locale, javax.print.attribute.Attribute, .PrintServiceAttribute, .TextSyntax
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

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
PrinterName(String
printer name
printerName, Locale
natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
locale)

Constructs a new printer name attribute with the given name and locale.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this printer name attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this printer name attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

public final String

Returns:

attribute category name
getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.TextSyntax:
getLocalegetValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

PrinterNameback to summary
public PrinterName(String printerName, Locale locale)

Constructs a new printer name attribute with the given name and locale.

Parameters
printerName:String

printer name

locale:Locale

natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Exceptions
NullPointerException:
if printerName is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.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:

  1. object is not null.
  2. object is an instance of class PrinterName.
  3. This printer name attribute's underlying string and object's underlying string are equal.
  4. This printer name attribute's locale and object's locale are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this printer name attribute, false otherwise

Annotations
@Override
getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

For class PrinterName, the category name is "printer-name".

Returns:String

attribute category name

Annotations
@Override