001/* PrinterName.java --
002   Copyright (C) 2004, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.print.attribute.standard;
040
041import java.util.Locale;
042
043import javax.print.attribute.Attribute;
044import javax.print.attribute.PrintServiceAttribute;
045import javax.print.attribute.TextSyntax;
046
047/**
048 * The <code>PrinterName</code> printing attribute provides the name of a
049 * print service. The name may but must not be related to parts of the
050 * printer URI.
051 * <p>
052 * <b>IPP Compatibility:</b> PrinterName is an IPP 1.1 attribute.
053 * </p>
054 * @see javax.print.attribute.standard.PrinterURI
055 *
056 * @author Michael Koch (konqueror@gmx.de)
057 */
058public final class PrinterName extends TextSyntax
059  implements PrintServiceAttribute
060{
061  private static final long serialVersionUID = 299740639137803127L;
062
063  /**
064   * Creates a <code>PrinterName</code> object.
065   *
066   * @param printerName the printer name
067   * @param locale the locale to use, if <code>null</code> the default
068   * locale is used.
069   *
070   * @exception NullPointerException if printerName is <code>null</code>.
071   */
072  public PrinterName(String printerName, Locale locale)
073  {
074    super(printerName, locale);
075  }
076
077  /**
078   * Tests if the given object is equal to this object.
079   *
080   * @param obj the object to test
081   *
082   * @return <code>true</code> if both objects are equal,
083   * <code>false</code> otherwise.
084   */
085  public boolean equals(Object obj)
086  {
087    if(! (obj instanceof PrinterName))
088      return false;
089
090    return super.equals(obj);
091  }
092
093  /**
094   * Returns category of this class.
095   *
096   * @return The class <code>PrinterName</code> itself.
097   */
098  public Class< ? extends Attribute> getCategory()
099  {
100    return PrinterName.class;
101  }
102
103  /**
104   * Returns the name of this attribute.
105   *
106   * @return The name "printer-name".
107   */
108  public String getName()
109  {
110    return "printer-name";
111  }
112}