libjava/classpath/javax/print/attribute/standard/PrinterState.java

   1 /* PrinterState.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 package javax.print.attribute.standard;
  39
  40 import javax.print.attribute.EnumSyntax;
  41 import javax.print.attribute.PrintServiceAttribute;
  42
  43
  44 /**
  45  * The <code>PrinterState</code> printing attribute reports
  46  * the current state of the printer device.
  47  * <p>
  48  * The {@link javax.print.attribute.standard.PrinterStateReasons}
  49  * attribute provides further detailed information about
  50  * the given printer state. Detailed information about the printer
  51  * state and printer state reasons attributes can be found in the
  52  * RFC 2911.
  53  * </p>
  54  * <p>
  55  * <b>IPP Compatibility:</b> PrinterState is an IPP 1.1 attribute.
  56  * </p>
  57  *
  58  * @author Michael Koch (konqueror@gmx.de)
  59  * @author Wolfgang Baer (WBaer@gmx.de)
  60  */
  61 public final class PrinterState extends EnumSyntax
  62   implements PrintServiceAttribute
  63 {
  64   private static final long serialVersionUID = -649578618346507718L;
  65
  66   /**
  67    * The state is unknown currently.
  68    */
  69   public static final PrinterState UNKNOWN = new PrinterState(0);
  70
  71   /**
  72    * The printer device is in idle state. New jobs can start
  73    * processing without waiting.
  74    */
  75   public static final PrinterState IDLE = new PrinterState(3);
  76
  77   /**
  78    * The printer device is in processing state.
  79    */
  80   public static final PrinterState PROCESSING = new PrinterState(4);
  81
  82   /**
  83    * The printer device has stopped. No jobs can be processed and
  84    * normally manual intervention is needed.
  85    */
  86   public static final PrinterState STOPPED = new PrinterState(5);
  87
  88   private static final String[] stringTable = { "unknown", null, null,
  89                                                 "idle", "processing",
  90                                                 "stopped" };
  91
  92   private static final PrinterState[] enumValueTable = { UNKNOWN, null, null,
  93                                                          IDLE, PROCESSING,
  94                                                          STOPPED };
  95
  96   /**
  97    * Constructs a <code>PrinterState</code> object.
  98    *
  99    * @param value the enum value.
 100    */
 101   protected PrinterState(int value)
 102   {
 103     super(value);
 104   }
 105
 106   /**
 107    * Returns category of this class.
 108    *
 109    * @return The class <code>PrinterState</code> itself.
 110    */
 111   public Class getCategory()
 112   {
 113     return PrinterState.class;
 114   }
 115
 116   /**
 117    * Returns the name of this attribute.
 118    *
 119    * @return The name "printer-state".
 120    */
 121   public String getName()
 122   {
 123     return "printer-state";
 124   }
 125
 126   /**
 127    * Returns a table with the enumeration values represented as strings
 128    * for this object.
 129    *
 130    * @return The enumeration values as strings.
 131    */
 132   protected String[] getStringTable()
 133   {
 134     return stringTable;
 135   }
 136
 137   /**
 138    * Returns a table with the enumeration values for this object.
 139    *
 140    * @return The enumeration values.
 141    */
 142   protected EnumSyntax[] getEnumValueTable()
 143   {
 144     return enumValueTable;
 145   }
 146 }