Source for javax.print.attribute.standard.JobMessageFromOperator

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