javax.print.attribute.standard
Class PrinterLocation

java.lang.Object
  extended by javax.print.attribute.TextSyntax
      extended by javax.print.attribute.standard.PrinterLocation
All Implemented Interfaces:
Serializable, Cloneable, Attribute, PrintServiceAttribute

public final class PrinterLocation
extends TextSyntax
implements PrintServiceAttribute

The PrinterLocation printing attribute provides the location of a printer device. This may be a room and building name for example.

IPP Compatibility: PrinterLocation is an IPP 1.1 attribute.

See Also:
Serialized Form

Constructor Summary
PrinterLocation(String printerLocation, Locale locale)
          Creates a PrinterLocation object.
 
Method Summary
 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

PrinterLocation

public PrinterLocation(String printerLocation,
                       Locale locale)
Creates a PrinterLocation object.

Parameters:
printerLocation - the printer location
locale - the locale to use, if null the default locale is used.
Throws:
NullPointerException - if printerLocation 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 PrinterLocation itself.

getName

public String getName()
Returns the name of this attribute.

Specified by:
getName in interface Attribute
Returns:
The name "printer-location".