Source for javax.print.attribute.standard.JobName

   1: /* JobName.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.PrintJobAttribute;
  45: import javax.print.attribute.PrintRequestAttribute;
  46: import javax.print.attribute.TextSyntax;
  47: 
  48: /**
  49:  * The <code>JobName</code> printing attribute provides the name of a 
  50:  * print job for identification.
  51:  * <p>
  52:  * <b>IPP Compatibility:</b> JobName is an IPP 1.1 attribute.
  53:  * </p>
  54:  * 
  55:  * @author Michael Koch (konqueror@gmx.de)
  56:  */
  57: public final class JobName extends TextSyntax
  58:   implements PrintJobAttribute, PrintRequestAttribute
  59: {
  60:   private static final long serialVersionUID = 4660359192078689545L;
  61: 
  62:   /**
  63:    * Creates a <code>JobName</code> object.
  64:    *
  65:    * @param jobName the job name.
  66:    * @param locale the locale to use, if <code>null</code> the default
  67:    * locale is used.
  68:    *
  69:    * @exception NullPointerException if jobName is <code>null</code>.
  70:    */
  71:   public JobName(String jobName, Locale locale)
  72:   {
  73:     super(jobName, locale);
  74:   }
  75: 
  76:   /**
  77:    * Tests if the given object is equal to this object.
  78:    *
  79:    * @param obj the object to test
  80:    *
  81:    * @return <code>true</code> if both objects are equal, 
  82:    * <code>false</code> otherwise.
  83:    */
  84:   public boolean equals(Object obj)
  85:   {
  86:     if(! (obj instanceof JobName))
  87:       return false;
  88: 
  89:     return super.equals(obj);
  90:   }
  91: 
  92:   /**
  93:    * Returns category of this class.
  94:    *
  95:    * @return The class <code>JobName</code> itself.
  96:    */
  97:   public Class< ? extends Attribute> getCategory()
  98:   {
  99:     return JobName.class;
 100:   }
 101: 
 102:   /**
 103:    * Returns the name of this attribute.
 104:    *
 105:    * @return The name "job-name".
 106:    */
 107:   public String getName()
 108:   {
 109:     return "job-name";
 110:   }
 111: }