/*
 * Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.print.attribute.standard;

import java.io.File;
import java.io.Serial;
import java.net.URI;

import javax.print.attribute.Attribute;
import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.PrintRequestAttribute;
import javax.print.attribute.URISyntax;

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.

Author:Phil Race
/** * Class {@code Destination} is a printing attribute class, a {@code URI}, that * is used to indicate an alternate destination for the spooled printer * formatted data. Many {@code PrintServices} will not support the notion of a * destination other than the printer device, and so will not support this * attribute. * <p> * 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 {@code URI} instances should be performed * using the {@code toURI()} method of class {@link File File}. See the * documentation on that class for more information. * <p> * If a destination {@code URI} is specified in a PrintRequest and it is not * accessible for output by the {@code PrintService}, a {@code PrintException} * will be thrown. The {@code PrintException} may implement {@code URIException} * to provide a more specific cause. * <p> * <b>IPP Compatibility:</b> Destination is not an IPP attribute. * * @author Phil Race */
public final class Destination extends URISyntax implements PrintJobAttribute, PrintRequestAttribute {
Use serialVersionUID from JDK 1.4 for interoperability.
/** * Use serialVersionUID from JDK 1.4 for interoperability. */
@Serial private static final long serialVersionUID = 6776739171700415321L;
Constructs a new destination attribute with the specified URI.
Params:
  • uri – URI
Throws:
/** * Constructs a new destination attribute with the specified {@code URI}. * * @param uri {@code URI} * @throws NullPointerException if {@code uri} is {@code null} */
public Destination(URI uri) { super (uri); }
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.
Params:
  • object – Object to compare to
Returns:true if object is equivalent to this destination attribute, false otherwise
/** * Returns whether this destination attribute is equivalent to the passed in * object. To be equivalent, all of the following conditions must be true: * <ol type=1> * <li>{@code object} is not {@code null}. * <li>{@code object} is an instance of class {@code Destination}. * <li>This destination attribute's {@code URI} and {@code object}'s * {@code URI} are equal. * </ol> * * @param object {@code Object} to compare to * @return {@code true} if {@code object} is equivalent to this destination * attribute, {@code false} otherwise */
public boolean equals(Object object) { return (super.equals(object) && object instanceof Destination); }
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:printing attribute class (category), an instance of class java.lang.Class
/** * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. * <p> * For class {@code Destination}, the category is class {@code Destination} * itself. * * @return printing attribute class (category), an instance of class * {@link Class java.lang.Class} */
public final Class<? extends Attribute> getCategory() { return Destination.class; }
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:attribute category name
/** * Get the name of the category of which this attribute value is an * instance. * <p> * For class {@code Destination}, the category name is * {@code "spool-data-destination"}. * * @return attribute category name */
public final String getName() { return "spool-data-destination"; } }