Source for javax.print.attribute.standard.PrinterName

   1: /* PrinterName.java -- 
   2:    Copyright (C) 2004, 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.print.attribute.standard;
  40: 
  41: import java.util.Locale;
  42: 
  43: import javax.print.attribute.Attribute;
  44: import javax.print.attribute.PrintServiceAttribute;
  45: import javax.print.attribute.TextSyntax;
  46: 
  47: /**
  48:  * The <code>PrinterName</code> printing attribute provides the name of a 
  49:  * print service. The name may but must not be related to parts of the
  50:  * printer URI.
  51:  * <p>
  52:  * <b>IPP Compatibility:</b> PrinterName is an IPP 1.1 attribute.
  53:  * </p>
  54:  * @see javax.print.attribute.standard.PrinterURI
  55:  * 
  56:  * @author Michael Koch (konqueror@gmx.de)
  57:  */
  58: public final class PrinterName extends TextSyntax
  59:   implements PrintServiceAttribute
  60: {
  61:   private static final long serialVersionUID = 299740639137803127L;
  62: 
  63:   /**
  64:    * Creates a <code>PrinterName</code> object.
  65:    *
  66:    * @param printerName the printer name
  67:    * @param locale the locale to use, if <code>null</code> the default
  68:    * locale is used.
  69:    *
  70:    * @exception NullPointerException if printerName is <code>null</code>.
  71:    */
  72:   public PrinterName(String printerName, Locale locale)
  73:   {
  74:     super(printerName, locale);
  75:   }
  76: 
  77:   /**
  78:    * Tests if the given object is equal to this object.
  79:    *
  80:    * @param obj the object to test
  81:    *
  82:    * @return <code>true</code> if both objects are equal, 
  83:    * <code>false</code> otherwise.
  84:    */
  85:   public boolean equals(Object obj)
  86:   {
  87:     if(! (obj instanceof PrinterName))
  88:       return false;
  89: 
  90:     return super.equals(obj);
  91:   }
  92: 
  93:   /**
  94:    * Returns category of this class.
  95:    *
  96:    * @return The class <code>PrinterName</code> itself.
  97:    */
  98:   public Class< ? extends Attribute> getCategory()
  99:   {
 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: }