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.PrintServiceAttribute;
032
033 /**
034 * Class PrinterMoreInfo is a printing attribute class, a URI, that is used to
035 * obtain more information about this specific printer. For example, this
036 * could be an HTTP type URI referencing an HTML page accessible to a web
037 * browser. The information obtained from this URI is intended for end user
038 * consumption. Features outside the scope of the Print Service API can be
039 * accessed from this URI.
040 * The information is intended to be specific to this printer instance and
041 * site specific services (e.g. job pricing, services offered, end user
042 * assistance).
043 * <P>
044 * In contrast, the {@link PrinterMoreInfoManufacturer
045 * PrinterMoreInfoManufacturer} attribute is used to find out more information
046 * about this general kind of printer rather than this specific printer.
047 * <P>
048 * <B>IPP Compatibility:</B> The string form returned by
049 * <CODE>toString()</CODE> gives the IPP uri value.
050 * The category name returned by <CODE>getName()</CODE>
051 * gives the IPP attribute name.
052 * <P>
053 *
054 * @author Alan Kaminsky
055 */
056 public final class PrinterMoreInfo extends URISyntax implements
057 PrintServiceAttribute {
058
059 private static final long serialVersionUID = 4555850007675338574L;
060
061 /**
062 * Constructs a new printer more info attribute with the specified URI.
063 *
064 * @param uri URI.
065 *
066 * @exception NullPointerException
067 * (unchecked exception) Thrown if <CODE>uri</CODE> is null.
068 */
069 public PrinterMoreInfo(URI uri) {
070 super (uri);
071 }
072
073 /**
074 * Returns whether this printer more info attribute is equivalent to the
075 * passed in object. To be equivalent, all of the following conditions
076 * must be true:
077 * <OL TYPE=1>
078 * <LI>
079 * <CODE>object</CODE> is not null.
080 * <LI>
081 * <CODE>object</CODE> is an instance of class PrinterMoreInfo.
082 * <LI>
083 * This printer more info attribute's URI and <CODE>object</CODE>'s URI
084 * are equal.
085 * </OL>
086 *
087 * @param object Object to compare to.
088 *
089 * @return True if <CODE>object</CODE> is equivalent to this printer
090 * more info attribute, false otherwise.
091 */
092 public boolean equals(Object object) {
093 return (super .equals(object) && object instanceof PrinterMoreInfo);
094 }
095
096 /**
097 * Get the printing attribute class which is to be used as the "category"
098 * for this printing attribute value.
099 * <P>
100 * For class PrinterMoreInfo, the category is class PrinterMoreInfo itself.
101 *
102 * @return Printing attribute class (category), an instance of class
103 * {@link java.lang.Class java.lang.Class}.
104 */
105 public final Class<? extends Attribute> getCategory() {
106 return PrinterMoreInfo.class;
107 }
108
109 /**
110 * Get the name of the category of which this attribute value is an
111 * instance.
112 * <P>
113 * For class PrinterMoreInfo, the
114 * category name is <CODE>"printer-more-info"</CODE>.
115 *
116 * @return Attribute category name.
117 */
118 public final String getName() {
119 return "printer-more-info";
120 }
121
122 }
|