JavaTM 2 Platform Std. Ed. v1.4.2
javax.print.attribute.standard
Class Destination
java.lang.Object
javax.print.attribute.URISyntax
javax.print.attribute.standard.Destination
- All Implemented Interfaces:
- Attribute, Cloneable, PrintJobAttribute, PrintRequestAttribute, Serializable
- public final class Destination
- extends URISyntax
- implements PrintJobAttribute, PrintRequestAttribute
Class Destination is a printing attribute class, a URI, that is used to
indicate an alternate destination for the spooled printer formatted
data. Many PrintServices will not support the notion of a destination
other than the printer device, and so will not support this attribute.
A common use for this attribute will be applications which want
to redirect output to a local disk file : eg."file:out.prn".
Note that proper construction of "file:" scheme URI instances should
be performed using the toURI() method of class
File .
See the documentation on that class for more information.
If a destination URI is specified in a PrintRequest and it is not
accessible for output by the PrintService, a PrintException will be thrown.
The PrintException may implement URIException to provide a more specific
cause.
IPP Compatibility: Destination is not an IPP attribute.
- See Also:
- Serialized Form
Constructor Summary |
Destination(URI uri)
Constructs a new destination attribute with the specified URI. |
Method Summary |
boolean |
equals(Object object)
Returns whether this destination attribute is equivalent to the
passed in object. |
Class |
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. |
Destination
public Destination(URI uri)
- Constructs a new destination attribute with the specified URI.
- Parameters:
uri - URI.
- Throws:
NullPointerException - (unchecked exception) Thrown if uri is null.
equals
public boolean equals(Object object)
- Returns whether this destination 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 Destination.
-
This destination attribute's URI and
object 's URI
are equal.
- Overrides:
equals in class URISyntax
- Parameters:
object - Object to compare to.
- Returns:
- True if
object is equivalent to this destination
attribute, false otherwise.
getCategory
public final Class getCategory()
- Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
For class Destination, the category is class Destination 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 Destination, the category name is "spool-data-destination" .
- Specified by:
getName in interface Attribute
- Returns:
- Attribute category name.
Copyright 2003 Sun Microsystems, Inc. All rights reserved
|