1/*
2 * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package javax.print.attribute.standard;
26
27import java.net.URI;
28
29import javax.print.attribute.Attribute;
30import javax.print.attribute.URISyntax;
31import javax.print.attribute.PrintRequestAttribute;
32import javax.print.attribute.PrintJobAttribute;
33
34/**
35 * Class Destination is a printing attribute class, a URI, that is used to
36 * indicate an alternate destination for the spooled printer formatted
37 * data. Many PrintServices will not support the notion of a destination
38 * other than the printer device, and so will not support this attribute.
39 * <p>
40 * A common use for this attribute will be applications which want
41 * to redirect output to a local disk file : eg."file:out.prn".
42 * Note that proper construction of "file:" scheme URI instances should
43 * be performed using the {@code toURI()} method of class
44 * {@link java.io.File File}.
45 * See the documentation on that class for more information.
46 * <p>
47 * If a destination URI is specified in a PrintRequest and it is not
48 * accessible for output by the PrintService, a PrintException will be thrown.
49 * The PrintException may implement URIException to provide a more specific
50 * cause.
51 * <P>
52 * <B>IPP Compatibility:</B> Destination is not an IPP attribute.
53 *
54 * @author  Phil Race.
55 */
56public final class Destination extends URISyntax
57        implements PrintJobAttribute, PrintRequestAttribute {
58
59    private static final long serialVersionUID = 6776739171700415321L;
60
61    /**
62     * Constructs a new destination attribute with the specified URI.
63     *
64     * @param  uri  URI.
65     *
66     * @exception  NullPointerException
67     *     (unchecked exception) Thrown if {@code uri} is null.
68     */
69    public Destination(URI uri) {
70        super (uri);
71    }
72
73    /**
74     * Returns whether this destination attribute is equivalent to the
75     * passed in object. To be equivalent, all of the following conditions
76     * must be true:
77     * <OL TYPE=1>
78     * <LI>
79     * {@code object} is not null.
80     * <LI>
81     * {@code object} is an instance of class Destination.
82     * <LI>
83     * This destination attribute's URI and {@code object}'s URI
84     * are equal.
85     * </OL>
86     *
87     * @param  object  Object to compare to.
88     *
89     * @return  True if {@code object} is equivalent to this destination
90     *         attribute, false otherwise.
91     */
92    public boolean equals(Object object) {
93        return (super.equals(object) &&
94                object instanceof Destination);
95    }
96
97    /**
98     * Get the printing attribute class which is to be used as the "category"
99     * for this printing attribute value.
100     * <P>
101     * For class Destination, the category is class Destination itself.
102     *
103     * @return  Printing attribute class (category), an instance of class
104     *          {@link java.lang.Class java.lang.Class}.
105     */
106    public final Class<? extends Attribute> getCategory() {
107        return Destination.class;
108    }
109
110    /**
111     * Get the name of the category of which this attribute value is an
112     * instance.
113     * <P>
114     * For class Destination, the category name is {@code "spool-data-destination"}.
115     *
116     * @return  Attribute category name.
117     */
118    public final String getName() {
119        return "spool-data-destination";
120    }
121
122}
123