Source for gnu.javax.print.ipp.attribute.printer.PrinterStateMessage

   1: /* PrinterStateMessage.java --
   2:    Copyright (C) 2006 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 gnu.javax.print.ipp.attribute.printer;
  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:  * PrinterStateMessage attribute as described in RFC 2911 section
  49:  * 4.4.13 provides a textual representation of the attributes
  50:  * printer-state and printer-state-reasons for consumption by
  51:  * humans.
  52:  *
  53:  * @author Wolfgang Baer (WBaer@gmx.de)
  54:  */
  55: public final class PrinterStateMessage extends TextSyntax
  56:   implements PrintServiceAttribute
  57: {
  58: 
  59:   /**
  60:    * Creates a <code>PrinterStateMessage</code> object with the
  61:    * given value and locale.
  62:    *
  63:    * @param value the value for this syntax
  64:    * @param locale the locale to use, if <code>null</code> the default
  65:    * locale is used.
  66:    *
  67:    * @exception NullPointerException if value is null
  68:    */
  69:   public PrinterStateMessage(String value, Locale locale)
  70:   {
  71:     super(value, locale);
  72:   }
  73: 
  74:   /**
  75:    * Returns category of this class.
  76:    *
  77:    * @return The class <code>PrinterStateMessage</code> itself.
  78:    */
  79:   public Class<? extends Attribute> getCategory()
  80:   {
  81:     return PrinterStateMessage.class;
  82:   }
  83: 
  84:   /**
  85:    * Returns the name of this attribute.
  86:    *
  87:    * @return The name "printer-state-message".
  88:    */
  89:   public String getName()
  90:   {
  91:     return "printer-state-message";
  92:   }
  93: 
  94: }