Source for javax.print.attribute.standard.JobState

   1: /* JobState.java --
   2:    Copyright (C) 2004, 2005, 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: package javax.print.attribute.standard;
  39: 
  40: import javax.print.attribute.EnumSyntax;
  41: import javax.print.attribute.PrintJobAttribute;
  42: 
  43: 
  44: /**
  45:  * The <code>JobState</code> printing attribute reports
  46:  * the current state of a job.
  47:  * <p>
  48:  * The {@link javax.print.attribute.standard.JobStateReasons}
  49:  * attribute provides further detailed information about
  50:  * the given job state. Detailed information about the job
  51:  * state and job state reasons can be found in the RFC 2911.
  52:  * </p> 
  53:  * <p>
  54:  * <b>IPP Compatibility:</b> JobState is an IPP 1.1 attribute.
  55:  * </p>
  56:  * 
  57:  * @author Michael Koch (konqueror@gmx.de)
  58:  * @author Wolfgang Baer (WBaer@gmx.de)
  59:  */
  60: public class JobState extends EnumSyntax
  61:   implements PrintJobAttribute
  62: {
  63:   private static final long serialVersionUID = 400465010094018920L;
  64: 
  65:   /**
  66:    * The job state is currently unknown.
  67:    */
  68:   public static final JobState UNKNOWN = new JobState(0);
  69:   
  70:   /**
  71:    * The job is pending processing.
  72:    */
  73:   public static final JobState PENDING = new JobState(3);
  74:   
  75:   /**
  76:    * The job is currently not a candidate for printing because
  77:    * of reasons reported by the job-state-reasons attribute. If
  78:    * the reasons are no longer present it will return to the
  79:    * pending state.
  80:    */
  81:   public static final JobState PENDING_HELD = new JobState(4);
  82:   
  83:   /**
  84:    * The job is currently processed.
  85:    */
  86:   public static final JobState PROCESSING = new JobState(5);
  87:   
  88:   /**
  89:    * The job's processing has stopped. The job-state-reasons
  90:    * attribute may indicate the reason(s). The job will return
  91:    * to the processing state if the reasons are no longer present.
  92:    */
  93:   public static final JobState PROCESSING_STOPPED = new JobState(6);
  94:   
  95:   /**
  96:    * The job has been canceled by the client.
  97:    */
  98:   public static final JobState CANCELED = new JobState(7);
  99:   
 100:   /**
 101:    * The job has been aborted by the system.
 102:    */
 103:   public static final JobState ABORTED = new JobState(8);
 104:   
 105:   /**
 106:    * The job has completed successfully.
 107:    */
 108:   public static final JobState COMPLETED = new JobState(9);
 109: 
 110: 
 111:   private static final String[] stringTable = { "unknown", null, null, 
 112:                                                 "pending", "pending-held",
 113:                                                 "processing", 
 114:                                                 "processing-stopped",
 115:                                                 "canceled", "aborted", 
 116:                                                 "completed"};
 117:   
 118:   private static final JobState[] enumValueTable = { UNKNOWN, null, null,
 119:                                                      PENDING, PENDING_HELD,
 120:                                                      PROCESSING,
 121:                                                      PROCESSING_STOPPED,
 122:                                                      CANCELED, ABORTED,
 123:                                                      COMPLETED };
 124:   
 125:   /**
 126:    * Constructs a <code>JobState</code> object.
 127:    * 
 128:    * @param value the enum value.
 129:    */
 130:   protected JobState(int value)
 131:   {
 132:     super(value);
 133:   }
 134: 
 135:   /**
 136:    * Returns category of this class.
 137:    *
 138:    * @return The class <code>JobState</code> itself.
 139:    */
 140:   public final Class getCategory()
 141:   {
 142:     return JobState.class;
 143:   }
 144: 
 145:   /**
 146:    * Returns the name of this attribute.
 147:    *
 148:    * @return The name "job-state".
 149:    */
 150:   public final String getName()
 151:   {
 152:     return "job-state";
 153:   }
 154:   
 155:   /**
 156:    * Returns a table with the enumeration values represented as strings
 157:    * for this object.
 158:    *
 159:    * @return The enumeration values as strings.
 160:    */
 161:   protected String[] getStringTable()
 162:   {
 163:     return stringTable;
 164:   }
 165: 
 166:   /**
 167:    * Returns a table with the enumeration values for this object.
 168:    *
 169:    * @return The enumeration values.
 170:    */
 171:   protected EnumSyntax[] getEnumValueTable()
 172:   {
 173:     return enumValueTable;
 174:   }
 175: }