1 /*
   2  * Copyright (c) 2000, 2013, 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  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.net.URI;
  28 
  29 import javax.print.attribute.Attribute;
  30 import javax.print.attribute.URISyntax;
  31 import javax.print.attribute.PrintServiceAttribute;
  32 
  33 /**
  34  * Class PrinterMoreInfoManufacturer is a printing attribute class, a URI,
  35  * that is used to obtain more information about this type of device.
  36  * The information obtained from this URI is intended for end user
  37  * consumption. Features outside the scope of the Print Service API
  38  * can be accessed from this URI (e.g.,
  39  * latest firmware, upgrades, service proxies, optional features available,
  40  * details on color support). The information is intended to be germane to
  41  * this kind of printer without regard to site specific modifications or
  42  * services.
  43  * <P>
  44  * In contrast, the {@link PrinterMoreInfo PrinterMoreInfo} attribute is used
  45  * to find out more information about this specific printer rather than this
  46  * general kind of printer.
  47  * <P>
  48  * <B>IPP Compatibility:</B> The string form returned by
  49  * <CODE>toString()</CODE> gives the IPP uri value.
  50  * The category name returned by <CODE>getName()</CODE>
  51  * gives the IPP attribute name.
  52  * <P>
  53  *
  54  * @author  Alan Kaminsky
  55  */
  56 public final class PrinterMoreInfoManufacturer extends URISyntax
  57         implements PrintServiceAttribute {
  58 
  59     private static final long serialVersionUID = 3323271346485076608L;
  60 
  61     /**
  62      * Constructs a new printer more info manufacturer attribute with the
  63      * specified URI.
  64      *
  65      * @param  uri  URI.
  66      *
  67      * @exception  NullPointerException
  68      *     (unchecked exception) Thrown if <CODE>uri</CODE> is null.
  69      */
  70     public PrinterMoreInfoManufacturer(URI uri) {
  71         super (uri);
  72     }
  73 
  74     /**
  75      * Returns whether this printer more info manufacturer attribute is
  76      * equivalent to the passed in object. To be equivalent, all of the
  77      * following conditions must be true:
  78      * <OL TYPE=1>
  79      * <LI>
  80      * <CODE>object</CODE> is not null.
  81      * <LI>
  82      * <CODE>object</CODE> is an instance of class
  83      * PrinterMoreInfoManufacturer.
  84      * <LI>
  85      * This printer more info manufacturer attribute's URI and
  86      * <CODE>object</CODE>'s URI are equal.
  87      * </OL>
  88      *
  89      * @param  object  Object to compare to.
  90      *
  91      * @return  True if <CODE>object</CODE> is equivalent to this printer
  92      *          more info manufacturer attribute, false otherwise.
  93      */
  94     public boolean equals(Object object) {
  95         return (super.equals(object) &&
  96                 object instanceof PrinterMoreInfoManufacturer);
  97     }
  98 
  99     /**
 100      * Get the printing attribute class which is to be used as the "category"
 101      * for this printing attribute value.
 102      * <P>
 103      * For class PrinterMoreInfoManufacturer, the category is
 104      * class PrinterMoreInfoManufacturer itself.
 105      *
 106      * @return  Printing attribute class (category), an instance of class
 107      *          {@link java.lang.Class java.lang.Class}.
 108      */
 109     public final Class<? extends Attribute> getCategory() {
 110         return PrinterMoreInfoManufacturer.class;
 111     }
 112 
 113     /**
 114      * Get the name of the category of which this attribute value is an
 115      * instance.
 116      * <P>
 117      * For class PrinterMoreInfoManufacturer, the category name is
 118      * <CODE>"printer-more-info-manufacturer"</CODE>.
 119      *
 120      * @return  Attribute category name.
 121      */
 122     public final String getName() {
 123         return "printer-more-info-manufacturer";
 124     }
 125 
 126 }