Class PrinterName

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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PrinterName(String printerName, Locale locale)
    Constructs a new printer name attribute with the given name and locale.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Returns whether this printer name attribute is equivalent to the passed in object.
    final Class<? extends Attribute>
    getCategory()
    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 TextSyntax

    getLocale, getValue, hashCode, toString
    Modifier and Type
    Method
    Description
    Locale
    getLocale()
    Returns this text attribute's text string's natural language (locale).
    String
    getValue()
    Returns this text attribute's text string.
    int
    hashCode()
    Returns a hashcode for this text attribute.
    String
    toString()
    Returns a String identifying this text attribute.

    Methods declared in class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • 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 - if printerName is null

  • Method Details

    • 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:
      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.
      Overrides:
      equals in class TextSyntax
      Parameters:
      object - Object to compare to
      Returns:
      true if object is equivalent to this printer name attribute, false otherwise
      See Also:

    • 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 interface Attribute
      Returns:
      printing attribute class (category), an instance of class java.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 in interface Attribute
      Returns:
      attribute category name