javax.print.attribute.standard

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

The PrinterName printing attribute provides the name of a print service. The name may but must not be related to parts of the printer URI.

IPP Compatibility: PrinterName is an IPP 1.1 attribute.

See Also:

PrinterURI, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrinterName(String printerName, Locale locale) Creates a PrinterName object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests if the given object is equal to this object.
Class<? extends Attribute>	getCategory() Returns category of this class.
String	getName() Returns the name of this attribute.

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

Constructor Detail

PrinterName

public PrinterName(String printerName,
           Locale locale)

Creates a PrinterName object.

Parameters:

printerName - the printer name

locale - the locale to use, if null the default locale is used.

Throws:

NullPointerException - if printerName is null.

Method Detail

equals

public boolean equals(Object obj)

Tests if the given object is equal to this object.

Overrides:

equals in class TextSyntax

Parameters:

obj - the object to test

Returns:

true if both objects are equal, false otherwise.

See Also:

Object.hashCode()

getCategory

public Class<? extends Attribute> getCategory()

Returns category of this class.

Specified by:

getCategory in interface Attribute

Returns:

The class PrinterName itself.

getName

public String getName()

Returns the name of this attribute.

Specified by:

getName in interface Attribute

Returns:

The name "printer-name".