001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.EnumSyntax;
029 import javax.print.attribute.PrintServiceAttribute;
030
031 /**
032 * Class PrinterState is a printing attribute class, an enumeration, that
033 * identifies the current state of a printer. Class PrinterState defines
034 * standard printer state values. A Print Service implementation only needs
035 * to report those printer states which are appropriate for the particular
036 * implementation; it does not have to report every defined printer state. The
037 * {@link PrinterStateReasons PrinterStateReasons} attribute augments the
038 * PrinterState attribute to give more detailed information about the printer
039 * in given printer state.
040 * <P>
041 * <B>IPP Compatibility:</B> The category name returned by
042 * <CODE>getName()</CODE> is the IPP attribute name. The enumeration's
043 * integer value is the IPP enum value. The <code>toString()</code> method
044 * returns the IPP string representation of the attribute value.
045 * <P>
046 *
047 * @author Alan Kaminsky
048 */
049 public final class PrinterState extends EnumSyntax implements
050 PrintServiceAttribute {
051
052 private static final long serialVersionUID = -649578618346507718L;
053
054 /**
055 * The printer state is unknown.
056 */
057 public static final PrinterState UNKNOWN = new PrinterState(0);
058
059 /**
060 * Indicates that new jobs can start processing without waiting.
061 */
062 public static final PrinterState IDLE = new PrinterState(3);
063
064 /**
065 * Indicates that jobs are processing;
066 * new jobs will wait before processing.
067 */
068 public static final PrinterState PROCESSING = new PrinterState(4);
069
070 /**
071 * Indicates that no jobs can be processed and intervention is required.
072 */
073 public static final PrinterState STOPPED = new PrinterState(5);
074
075 /**
076 * Construct a new printer state enumeration value with the given integer
077 * value.
078 *
079 * @param value Integer value.
080 */
081 protected PrinterState(int value) {
082 super (value);
083 }
084
085 private static final String[] myStringTable = { "unknown", null,
086 null, "idle", "processing", "stopped" };
087
088 private static final PrinterState[] myEnumValueTable = { UNKNOWN,
089 null, null, IDLE, PROCESSING, STOPPED };
090
091 /**
092 * Returns the string table for class PrinterState.
093 */
094 protected String[] getStringTable() {
095 return myStringTable;
096 }
097
098 /**
099 * Returns the enumeration value table for class PrinterState.
100 */
101 protected EnumSyntax[] getEnumValueTable() {
102 return myEnumValueTable;
103 }
104
105 /**
106 * Get the printing attribute class which is to be used as the "category"
107 * for this printing attribute value.
108 * <P>
109 * For class PrinterState, the category is class PrinterState itself.
110 *
111 * @return Printing attribute class (category), an instance of class
112 * {@link java.lang.Class java.lang.Class}.
113 */
114 public final Class<? extends Attribute> getCategory() {
115 return PrinterState.class;
116 }
117
118 /**
119 * Get the name of the category of which this attribute value is an
120 * instance.
121 * <P>
122 * For class PrinterState, the category name is <CODE>"printer-state"</CODE>.
123 *
124 * @return Attribute category name.
125 */
126 public final String getName() {
127 return "printer-state";
128 }
129
130 }
|