FileDocCategorySizeDatePackage
Destination.javaAPI DocJava SE 5 API3434Fri Aug 26 14:57:44 BST 2005javax.print.attribute.standard

Destination

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 {@link java.io.File 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.

author
Phil Race.

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public Destination(URI uri)
Constructs a new destination attribute with the specified URI.

param
uri URI.
exception
NullPointerException (unchecked exception) Thrown if uri is null.


                                      
       
	super (uri);
Methods Summary
public booleanequals(java.lang.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:
  1. object is not null.
  2. object is an instance of class Destination.
  3. This destination attribute's URI and object's URI are equal.

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

	return (super.equals(object) && 
		object instanceof Destination);
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 Destination, the category is class Destination itself.

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

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

For class Destination, the category name is "spool-data-destination".

return
Attribute category name.

	return "spool-data-destination";