OpenJDK 27 · javax.print.attribute.standard.Destination

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.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.URISyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access	Constructor and Description
public	Destination(URI `URI` uri) Constructs a new destination attribute with the specified `URI`.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this destination attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.URISyntax.equals. Returns whether this destination attribute is equivalent to the passed in object.
public final Class<? extends Attribute>	Returns: printing attribute class (category), an instance of class `java.lang.Class` getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
public final String	Returns: attribute category name getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.URISyntax:: getURI hashCode toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.URISyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides javax.print.attribute.URISyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

Constructor Detail

Destination back to summary

Destination	back to summary
public Destination(URI uri) Constructs a new destination attribute with the specified `URI`. Parameters uri:URI `URI` Exceptions NullPointerException: if `uri` is `null`

public Destination(URI uri)

Constructs a new destination attribute with the specified URI.

Parameters

uri:URI: URI

Exceptions

NullPointerException:: if uri is null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.URISyntax.equals. 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. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this destination attribute, `false` otherwise Annotations @Override

public boolean equals(Object object)

Overrides javax.print.attribute.URISyntax.equals.

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.

Parameters

object:Object: Object to compare to

Returns:boolean

true if object is equivalent to this destination attribute, false otherwise

Annotations

@Override

getCategory back to summary

getCategory	back to summary
public final Class<? extends Attribute> getCategory() Implements javax.print.attribute.Attribute.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. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.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.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations

@Override

getName back to summary

getName	back to summary
public final String getName() Implements javax.print.attribute.Attribute.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"`. Returns:String attribute category name Annotations @Override

public final String getName()

Implements javax.print.attribute.Attribute.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".

Returns:String

attribute category name

Annotations

@Override

public final Class Destination

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail