FileDocCategorySizeDatePackage
PrinterLocation.javaAPI DocJava SE 5 API3291Fri Aug 26 14:57:46 BST 2005javax.print.attribute.standard

PrinterLocation

public final class PrinterLocation extends TextSyntax implements PrintServiceAttribute
Class PrinterLocation is a printing attribute class, a text attribute, that identifies the location of the device. This could include things like: "in Room 123A, second floor of building XYZ".

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

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public PrinterLocation(String location, Locale locale)
Constructs a new printer location attribute with the given location and locale.

param
location Printer location.
param
locale Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
exception
NullPointerException (unchecked exception) Thrown if location is null.


                                                                    
         
	super (location, locale);
    
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this printer location 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 PrinterLocation.
  3. This printer location attribute's underlying string and object's underlying string are equal.
  4. This printer location attribute's locale and object's locale are equal.

param
object Object to compare to.
return
True if object is equivalent to this printer location attribute, false otherwise.

	return (super.equals(object) && object instanceof PrinterLocation);
    
public final java.lang.ClassgetCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class PrinterLocation, the category is class PrinterLocation itself.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return PrinterLocation.class;
    
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class PrinterLocation, the category name is "printer-location".

return
Attribute category name.

	return "printer-location";