Source for javax.print.attribute.standard.JobOriginatingUserName

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