- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.PrinterLocation
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintServiceAttribute
public final class PrinterLocation extends TextSyntax implements PrintServiceAttribute
ClassPrinterLocationis 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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PrinterLocation(String location, Locale locale)Constructs a new printer location attribute with the given location and locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returns whether this printer location attribute is equivalent to the passed in object.Class<? extends Attribute>getCategory()Get the printing attribute class which is to be used as the "category" for this printing attribute value.StringgetName()Get the name of the category of which this attribute value is an instance.-
Methods declared in class javax.print.attribute.TextSyntax
getLocale, getValue, hashCode, toString
-
-
-
-
Constructor Detail
-
PrinterLocation
public PrinterLocation(String location, Locale locale)
Constructs a new printer location attribute with the given location and locale.- Parameters:
location- printer locationlocale- natural language of the text string.nullis interpreted to mean the default locale as returned byLocale.getDefault()- Throws:
NullPointerException- iflocationisnull
-
-
Method Detail
-
equals
public boolean equals(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:objectis notnull.objectis an instance of classPrinterLocation.- 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.
- Overrides:
equalsin classTextSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this printer location attribute,falseotherwise- See Also:
Object.hashCode(),HashMap
-
getCategory
public final Class<? extends Attribute> getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.For class
PrinterLocation, the category is classPrinterLocationitself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-