javax.print.attribute.standard: public final class: PrinterName

javax.print.attribute.standard
public final class: PrinterName [javadoc | source]

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

All Implemented Interfaces:
PrintServiceAttribute, Cloneable, java$io$Serializable

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:

Constructor:
public PrinterName(String printerName, Locale locale) { super (printerName, 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` - (unchecked exception) Thrown if `printerName` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `printerName` is null.

 public PrinterName(String printerName,
    Locale locale) {
        super (printerName, 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 - (unchecked exception) Thrown if printerName is null.

exception: NullPointerException - (unchecked exception) Thrown if printerName is null.

Method from javax.print.attribute.standard.PrinterName Summary:
equals, getCategory, getName

Methods from javax.print.attribute.TextSyntax:
equals, getLocale, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.PrinterName Detail:
public boolean equals(Object object) { return (super.equals(object) && object instanceof PrinterName); } 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.
public final Class<Attribute> getCategory() { return PrinterName.class; } 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.
public final String getName() { return "printer-name"; } Get the name of the category of which this attribute value is an instance. For class PrinterName, the category name is `"printer-name"`.

Method from javax.print.attribute.standard.PrinterName Detail:

 public boolean equals(Object object) {
        return (super.equals(object) && object instanceof PrinterName);
}

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.

 public final Class<Attribute> getCategory() {
        return PrinterName.class;
}

For class PrinterName, the category is class PrinterName itself.

 public final String getName() {
        return "printer-name";
}

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