Java™ Platform
Standard Ed. 6

javax.print.attribute.standard
Class PrinterURI

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

public final class PrinterURI
extends URISyntax
implements PrintServiceAttribute

Class PrinterURI is a printing attribute class, a URI, that specifies the globally unique name of a printer. If it has such a name, an administrator determines a printer's URI and sets this attribute to that name.

IPP Compatibility: This implements the IPP printer-uri attribute. The string form returned by toString() gives the IPP printer-uri value. The category name returned by getName() gives the IPP attribute name.

See Also:
Serialized Form

Constructor Summary
PrinterURI(URI uri)
          Constructs a new PrinterURI attribute with the specified URI.
 
Method Summary
 boolean equals(Object object)
          Returns whether this printer name 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.
 String getName()
          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.URISyntax
getURI, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PrinterURI

public PrinterURI(URI uri)
Constructs a new PrinterURI attribute with the specified URI.

Parameters:
uri - URI of the printer
Throws:
NullPointerException - (unchecked exception) Thrown if uri is null.
Method Detail

equals

public boolean equals(Object object)
Returns whether this printer name 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 PrinterURI.
  3. This PrinterURI attribute's underlying URI and object's underlying URI are equal.

Overrides:
equals in class URISyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this PrinterURI attribute, false otherwise.
See Also:
Object.hashCode(), Hashtable

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 PrinterURI and any vendor-defined subclasses, the category is class PrinterURI itself.

Specified by:
getCategory in interface Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class.

getName

public final String getName()
Get the name of the category of which this attribute value is an instance.

For class PrinterURI and any vendor-defined subclasses, the category name is "printer-uri".

Specified by:
getName in interface Attribute
Returns:
Attribute category name.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.