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

   1 /* PrinterIsAcceptingJobs.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>PrinterIsAcceptingJobs</code> printing attribute signals
  46  * if a print services is currently accepting jobs.
  47  * <p>
  48  * <b>IPP Compatibility:</b> PrinterIsAcceptingJobs is an IPP 1.1 attribute.
  49  * The IPP specification treats PrinterIsAcceptingJobs as boolean type which
  50  * is not available in the Java Print Service API. The IPP boolean value "true"
  51  * corresponds to <code>ACCEPTING_JOBS</code> and "false"
  52  * to <code>NOT_ACCEPTING_JOBS</code>.
  53  * </p>
  54  *
  55  * @author Michael Koch (konqueror@gmx.de)
  56  * @author Wolfgang Baer (WBaer@gmx.de)
  57  */
  58 public class PrinterIsAcceptingJobs extends EnumSyntax
  59   implements PrintServiceAttribute
  60 {
  61   private static final long serialVersionUID = -5052010680537678061L;
  62
  63   /**
  64    * The printer is not accepting jobs currently.
  65    */
  66   public static final PrinterIsAcceptingJobs NOT_ACCEPTING_JOBS =
  67     new PrinterIsAcceptingJobs(0);
  68
  69   /**
  70    * The printer is accepting jobs.
  71    */
  72   public static final PrinterIsAcceptingJobs ACCEPTING_JOBS =
  73     new PrinterIsAcceptingJobs(1);
  74
  75   private static final String[] stringTable = { "not-accepting-jobs",
  76                                                 "accepting-jobs" };
  77
  78   private static final PrinterIsAcceptingJobs[] enumValueTable =
  79     { NOT_ACCEPTING_JOBS, ACCEPTING_JOBS };
  80
  81   /**
  82    * Constructs a <code>PrinterIsAcceptingJobs</code> object.
  83    *
  84    * @param value the enum value.
  85    */
  86   protected PrinterIsAcceptingJobs(int value)
  87   {
  88     super(value);
  89   }
  90
  91   /**
  92    * Returns category of this class.
  93    *
  94    * @return The class <code>PrinterIsAcceptingJobs</code> itself.
  95    */
  96   public Class getCategory()
  97   {
  98     return PrinterIsAcceptingJobs.class;
  99   }
 100
 101   /**
 102    * Returns the name of this attribute.
 103    *
 104    * @return The name "printer-is-accepting-jobs".
 105    */
 106   public String getName()
 107   {
 108     return "printer-is-accepting-jobs";
 109   }
 110
 111   /**
 112    * Returns a table with the enumeration values represented as strings
 113    * for this object.
 114    *
 115    * @return The enumeration values as strings.
 116    */
 117   protected String[] getStringTable()
 118   {
 119     return stringTable;
 120   }
 121
 122   /**
 123    * Returns a table with the enumeration values for this object.
 124    *
 125    * @return The enumeration values.
 126    */
 127   protected EnumSyntax[] getEnumValueTable()
 128   {
 129     return enumValueTable;
 130   }
 131 }