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