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 PrinterIsAcceptingJobs is a printing attribute class, an enumeration,
033 * that indicates whether the printer is currently able to accept jobs. This
034 * value is independent of the {@link PrinterState PrinterState} and {@link
035 * PrinterStateReasons PrinterStateReasons} attributes because its value does
036 * not affect the current job; rather it affects future jobs. If the value is
037 * NOT_ACCEPTING_JOBS, the printer will reject jobs even when the {@link
038 * PrinterState PrinterState} is IDLE. If value is ACCEPTING_JOBS, the Printer
039 * will accept jobs even when the {@link PrinterState PrinterState} is STOPPED.
040 * <P>
041 * <B>IPP Compatibility:</B> The IPP boolean value is "true" for ACCEPTING_JOBS
042 * and "false" for NOT_ACCEPTING_JOBS. TThe category name returned by
043 * <CODE>getName()</CODE> is the IPP attribute name. The enumeration's
044 * integer value is the IPP enum value. The <code>toString()</code> method
045 * returns the IPP string representation of the attribute value.
046 * <P>
047 *
048 * @author Alan Kaminsky
049 */
050 public final class PrinterIsAcceptingJobs extends EnumSyntax implements
051 PrintServiceAttribute {
052
053 private static final long serialVersionUID = -5052010680537678061L;
054
055 /**
056 * The printer is currently rejecting any jobs sent to it.
057 */
058 public static final PrinterIsAcceptingJobs NOT_ACCEPTING_JOBS = new PrinterIsAcceptingJobs(
059 0);
060
061 /**
062 * The printer is currently acccepting jobs.
063 */
064 public static final PrinterIsAcceptingJobs ACCEPTING_JOBS = new PrinterIsAcceptingJobs(
065 1);
066
067 /**
068 * Construct a new printer is accepting jobs enumeration value with the
069 * given integer value.
070 *
071 * @param value Integer value.
072 */
073 protected PrinterIsAcceptingJobs(int value) {
074 super (value);
075 }
076
077 private static final String[] myStringTable = {
078 "not-accepting-jobs", "accepting-jobs" };
079
080 private static final PrinterIsAcceptingJobs[] myEnumValueTable = {
081 NOT_ACCEPTING_JOBS, ACCEPTING_JOBS };
082
083 /**
084 * Returns the string table for class PrinterIsAcceptingJobs.
085 */
086 protected String[] getStringTable() {
087 return myStringTable;
088 }
089
090 /**
091 * Returns the enumeration value table for class PrinterIsAcceptingJobs.
092 */
093 protected EnumSyntax[] getEnumValueTable() {
094 return myEnumValueTable;
095 }
096
097 /**
098 * Get the printing attribute class which is to be used as the "category"
099 * for this printing attribute value.
100 * <P>
101 * For class PrinterIsAcceptingJobs, the
102 * category is class PrinterIsAcceptingJobs itself.
103 *
104 * @return Printing attribute class (category), an instance of class
105 * {@link java.lang.Class java.lang.Class}.
106 */
107 public final Class<? extends Attribute> getCategory() {
108 return PrinterIsAcceptingJobs.class;
109 }
110
111 /**
112 * Get the name of the category of which this attribute value is an
113 * instance.
114 * <P>
115 * For class PrinterIsAcceptingJobs, the
116 * category name is <CODE>"printer-is-accepting-jobs"</CODE>.
117 *
118 * @return Attribute category name.
119 */
120 public final String getName() {
121 return "printer-is-accepting-jobs";
122 }
123
124 }
|