Source for javax.print.attribute.standard.PrinterState

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