PrinterName (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
class PrinterName

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

All Implemented Interfaces:: Serializable, Cloneable, 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.

Constructor Summary
`PrinterName(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`	`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
`equals, getLocale, getValue, hashCode, toString`

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

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()

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 class TextSyntax
Parameters:: object - Object to compare to.
Returns:: True if object is equivalent to this printer name attribute, false otherwise.

getCategory

public final Class 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:: Printing attribute class (category), an instance of class {@link java.lang.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".

Returns:: Attribute category name.