1 /*
   2  * Copyright (c) 2000, 2014, 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 PrinterIsAcceptingJobs is a printing attribute class, an enumeration,
  33  * that indicates whether the printer is currently able to accept jobs. This
  34  * value is independent of the {@link PrinterState PrinterState} and {@link
  35  * PrinterStateReasons PrinterStateReasons} attributes because its value does
  36  * not affect the current job; rather it affects future jobs. If the value is
  37  * NOT_ACCEPTING_JOBS, the printer will reject jobs even when the {@link
  38  * PrinterState PrinterState} is IDLE. If value is ACCEPTING_JOBS, the Printer
  39  * will accept jobs even when the {@link PrinterState PrinterState} is STOPPED.
  40  * <P>
  41  * <B>IPP Compatibility:</B> The IPP boolean value is "true" for ACCEPTING_JOBS
  42  * and "false" for NOT_ACCEPTING_JOBS. The category name returned by
  43  * {@code getName()} is the IPP attribute name.  The enumeration's
  44  * integer value is the IPP enum value.  The {@code toString()} method
  45  * returns the IPP string representation of the attribute value.
  46  *
  47  * @author  Alan Kaminsky
  48  */
  49 public final class PrinterIsAcceptingJobs extends EnumSyntax
  50         implements PrintServiceAttribute {
  51 
  52     private static final long serialVersionUID = -5052010680537678061L;
  53 
  54     /**
  55      * The printer is currently rejecting any jobs sent to it.
  56      */
  57     public static final PrinterIsAcceptingJobs
  58         NOT_ACCEPTING_JOBS = new PrinterIsAcceptingJobs(0);
  59 
  60     /**
  61      * The printer is currently accepting jobs.
  62      */
  63     public static final PrinterIsAcceptingJobs
  64         ACCEPTING_JOBS = new PrinterIsAcceptingJobs(1);
  65 
  66     /**
  67      * Construct a new printer is accepting jobs enumeration value with the
  68      * given integer value.
  69      *
  70      * @param  value  Integer value.
  71      */
  72     protected PrinterIsAcceptingJobs(int value) {
  73         super (value);
  74     }
  75 
  76     private static final String[] myStringTable = {
  77         "not-accepting-jobs",
  78         "accepting-jobs"
  79     };
  80 
  81     private static final PrinterIsAcceptingJobs[] myEnumValueTable = {
  82         NOT_ACCEPTING_JOBS,
  83         ACCEPTING_JOBS
  84     };
  85 
  86     /**
  87      * Returns the string table for class PrinterIsAcceptingJobs.
  88      */
  89     protected String[] getStringTable() {
  90         return myStringTable;
  91     }
  92 
  93     /**
  94      * Returns the enumeration value table for class PrinterIsAcceptingJobs.
  95      */
  96     protected EnumSyntax[] getEnumValueTable() {
  97         return myEnumValueTable;
  98     }
  99 
 100     /**
 101      * Get the printing attribute class which is to be used as the "category"
 102      * for this printing attribute value.
 103      * <P>
 104      * For class PrinterIsAcceptingJobs, the
 105      * category is class PrinterIsAcceptingJobs itself.
 106      *
 107      * @return  Printing attribute class (category), an instance of class
 108      *          {@link java.lang.Class java.lang.Class}.
 109      */
 110     public final Class<? extends Attribute> getCategory() {
 111         return PrinterIsAcceptingJobs.class;
 112     }
 113 
 114     /**
 115      * Get the name of the category of which this attribute value is an
 116      * instance.
 117      * <P>
 118      * For class PrinterIsAcceptingJobs, the
 119      * category name is {@code "printer-is-accepting-jobs"}.
 120      *
 121      * @return  Attribute category name.
 122      */
 123     public final String getName() {
 124         return "printer-is-accepting-jobs";
 125     }
 126 
 127 }