PrinterName (Java 2 Platform SE 5.0) (original) (raw)

javax.print.attribute.standard

Class PrinterName

java.lang.Object extended by javax.print.attribute.TextSyntax javax.print.attribute.standard.PrinterName

All Implemented Interfaces:

Serializable, Cloneable, Attribute, PrintServiceAttribute

public final class PrinterName

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
[PrinterName](../../../../javax/print/attribute/standard/PrinterName.html#PrinterName%28java.lang.String, java.util.Locale%29)(String printerName,Locale locale) Constructs a new printer name attribute with the given name and locale.

Method Summary
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.

Methods inherited from class javax.print.attribute.TextSyntax
getLocale, getValue, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29)

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 by Locale.getDefault()

Throws:

[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - (unchecked exception) Thrown if printerName 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](../../../../javax/print/attribute/TextSyntax.html#equals%28java.lang.Object%29) in class [TextSyntax](../../../../javax/print/attribute/TextSyntax.html "class in javax.print.attribute")

Parameters:

object - Object to compare to.

Returns:

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

See Also:

Object.hashCode(), Hashtable

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](../../../../javax/print/attribute/Attribute.html#getCategory%28%29) in interface [Attribute](../../../../javax/print/attribute/Attribute.html "interface in javax.print.attribute")

Returns:

Printing attribute class (category), an instance of classjava.lang.Class.

getName

public final String getName()

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

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

Specified by:

[getName](../../../../javax/print/attribute/Attribute.html#getName%28%29) in interface [Attribute](../../../../javax/print/attribute/Attribute.html "interface in javax.print.attribute")

Returns:

Attribute category name.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.