1 /*
   2  * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import javax.print.attribute.Attribute;
  28 import javax.print.attribute.EnumSyntax;
  29 import javax.print.attribute.PrintServiceAttribute;
  30 
  31 /**
  32  * Class PrinterState is a printing attribute class, an enumeration, that
  33  * identifies the current state of a printer. Class PrinterState defines
  34  * standard printer state values. A Print Service implementation only needs
  35  * to report those printer states which are appropriate for the particular
  36  * implementation; it does not have to report every defined printer state. The
  37  * {@link PrinterStateReasons PrinterStateReasons} attribute augments the
  38  * PrinterState attribute to give more detailed information about the printer
  39  * in  given printer state.
  40  * <P>
  41  * <B>IPP Compatibility:</B> The category name returned by
  42  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's
  43  * integer value is the IPP enum value.  The <code>toString()</code> method
  44  * returns the IPP string representation of the attribute value.
  45  * <P>
  46  *
  47  * @author  Alan Kaminsky
  48  */
  49 public final class PrinterState extends EnumSyntax
  50 implements PrintServiceAttribute {
  51 
  52     private static final long serialVersionUID = -649578618346507718L;
  53 
  54     /**
  55      * The printer state is unknown.
  56      */
  57     public static final PrinterState UNKNOWN = new PrinterState(0);
  58 
  59     /**
  60      * Indicates that new jobs can start processing without waiting.
  61      */
  62     public static final PrinterState IDLE = new PrinterState(3);
  63 
  64     /**
  65      * Indicates that jobs are processing;
  66      * new jobs will wait before processing.
  67      */
  68     public static final PrinterState PROCESSING = new PrinterState(4);
  69 
  70     /**
  71      * Indicates that no jobs can be processed and intervention is required.
  72      */
  73     public static final PrinterState STOPPED = new PrinterState(5);
  74 
  75     /**
  76      * Construct a new printer state enumeration value with the given integer
  77      * value.
  78      *
  79      * @param  value  Integer value.
  80      */
  81     protected PrinterState(int value) {
  82         super (value);
  83     }
  84 
  85     private static final String[] myStringTable = {
  86         "unknown",
  87         null,
  88         null,
  89         "idle",
  90         "processing",
  91         "stopped"
  92     };
  93 
  94     private static final PrinterState[] myEnumValueTable = {
  95         UNKNOWN,
  96         null,
  97         null,
  98         IDLE,
  99         PROCESSING,
 100         STOPPED
 101     };
 102 
 103     /**
 104      * Returns the string table for class PrinterState.
 105      */
 106     protected String[] getStringTable() {
 107         return myStringTable;
 108     }
 109 
 110     /**
 111      * Returns the enumeration value table for class PrinterState.
 112      */
 113     protected EnumSyntax[] getEnumValueTable() {
 114         return myEnumValueTable;
 115     }
 116 
 117     /**
 118      * Get the printing attribute class which is to be used as the "category"
 119      * for this printing attribute value.
 120      * <P>
 121      * For class PrinterState, the category is class PrinterState itself.
 122      *
 123      * @return  Printing attribute class (category), an instance of class
 124      *          {@link java.lang.Class java.lang.Class}.
 125      */
 126     public final Class<? extends Attribute> getCategory() {
 127         return PrinterState.class;
 128     }
 129 
 130     /**
 131      * Get the name of the category of which this attribute value is an
 132      * instance.
 133      * <P>
 134      * For class PrinterState, the category name is <CODE>"printer-state"</CODE>.
 135      *
 136      * @return  Attribute category name.
 137      */
 138     public final String getName() {
 139         return "printer-state";
 140     }
 141 
 142 }