javax.print.attribute.standard: public final class: PrinterLocation

javax.print.attribute.standard
public final class: PrinterLocation [javadoc | source]

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

All Implemented Interfaces:
PrintServiceAttribute, Cloneable, java$io$Serializable

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

Constructor:

Constructor:
public PrinterLocation(String location, Locale locale) { super (location, locale); } Constructs a new printer location attribute with the given location and locale. Parameters: `location` - Printer location. `locale` - Natural language of the text string. null is interpreted to mean the default locale as returned by `Locale.getDefault()` Throws: `NullPointerException` - (unchecked exception) Thrown if `location` is null. exception: `NullPointerException` - (unchecked exception) Thrown if `location` is null.

 public PrinterLocation(String location,
    Locale locale) {
        super (location, locale);
}

Constructs a new printer location attribute with the given location and locale.

Parameters:

location - Printer location.

locale - Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Throws:

NullPointerException - (unchecked exception) Thrown if location is null.

exception: NullPointerException - (unchecked exception) Thrown if location is null.

Method from javax.print.attribute.standard.PrinterLocation Summary:
equals, getCategory, getName

Methods from javax.print.attribute.TextSyntax:
equals, getLocale, getValue, hashCode, toString

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

Method from javax.print.attribute.standard.PrinterLocation Detail:
public boolean equals(Object object) { return (super.equals(object) && object instanceof PrinterLocation); } Returns whether this printer location 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 PrinterLocation. This printer location attribute's underlying string and `object`'s underlying string are equal. This printer location attribute's locale and `object`'s locale are equal.
public final Class<Attribute> getCategory() { return PrinterLocation.class; } 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.
public final String getName() { return "printer-location"; } Get the name of the category of which this attribute value is an instance. For class PrinterLocation, the category name is `"printer-location"`.

Method from javax.print.attribute.standard.PrinterLocation Detail:

 public boolean equals(Object object) {
        return (super.equals(object) && object instanceof PrinterLocation);
}

object is not null.
object is an instance of class PrinterLocation.
This printer location attribute's underlying string and object's underlying string are equal.
This printer location attribute's locale and object's locale are equal.

 public final Class<Attribute> getCategory() {
        return PrinterLocation.class;
}

For class PrinterLocation, the category is class PrinterLocation itself.

 public final String getName() {
        return "printer-location";
}

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