001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import java.net.URI;
028
029 import javax.print.attribute.Attribute;
030 import javax.print.attribute.URISyntax;
031 import javax.print.attribute.PrintRequestAttribute;
032 import javax.print.attribute.PrintJobAttribute;
033
034 /**
035 * Class Destination is a printing attribute class, a URI, that is used to
036 * indicate an alternate destination for the spooled printer formatted
037 * data. Many PrintServices will not support the notion of a destination
038 * other than the printer device, and so will not support this attribute.
039 * <p>
040 * A common use for this attribute will be applications which want
041 * to redirect output to a local disk file : eg."file:out.prn".
042 * Note that proper construction of "file:" scheme URI instances should
043 * be performed using the <code>toURI()</code> method of class
044 * {@link java.io.File File}.
045 * See the documentation on that class for more information.
046 * <p>
047 * If a destination URI is specified in a PrintRequest and it is not
048 * accessible for output by the PrintService, a PrintException will be thrown.
049 * The PrintException may implement URIException to provide a more specific
050 * cause.
051 * <P>
052 * <B>IPP Compatibility:</B> Destination is not an IPP attribute.
053 * <P>
054 *
055 * @author Phil Race.
056 */
057 public final class Destination extends URISyntax implements
058 PrintJobAttribute, PrintRequestAttribute {
059
060 private static final long serialVersionUID = 6776739171700415321L;
061
062 /**
063 * Constructs a new destination attribute with the specified URI.
064 *
065 * @param uri URI.
066 *
067 * @exception NullPointerException
068 * (unchecked exception) Thrown if <CODE>uri</CODE> is null.
069 */
070 public Destination(URI uri) {
071 super (uri);
072 }
073
074 /**
075 * Returns whether this destination attribute is equivalent to the
076 * passed in object. To be equivalent, all of the following conditions
077 * must be true:
078 * <OL TYPE=1>
079 * <LI>
080 * <CODE>object</CODE> is not null.
081 * <LI>
082 * <CODE>object</CODE> is an instance of class Destination.
083 * <LI>
084 * This destination attribute's URI and <CODE>object</CODE>'s URI
085 * are equal.
086 * </OL>
087 *
088 * @param object Object to compare to.
089 *
090 * @return True if <CODE>object</CODE> is equivalent to this destination
091 * attribute, false otherwise.
092 */
093 public boolean equals(Object object) {
094 return (super .equals(object) && object instanceof Destination);
095 }
096
097 /**
098 * Get the printing attribute class which is to be used as the "category"
099 * 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"</CODE>.
115 *
116 * @return Attribute category name.
117 */
118 public final String getName() {
119 return "spool-data-destination";
120 }
121
122 }
|