1 /*
   2  * Copyright (c) 2000, 2017, 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 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.EnumSyntax;
  30 import javax.print.attribute.PrintServiceAttribute;
  31 
  32 /**
  33  * Class {@code PDLOverrideSupported} is a printing attribute class, an
  34  * enumeration, that expresses the printer's ability to attempt to override
  35  * processing instructions embedded in documents' print data with processing
  36  * instructions specified as attributes outside the print data.
  37  * <p>
  38  * <b>IPP Compatibility:</b> The category name returned by {@code getName()} is
  39  * the IPP attribute name. The enumeration's integer value is the IPP enum
  40  * value. The {@code toString()} method returns the IPP string representation of
  41  * the attribute value.
  42  *
  43  * @author Alan Kaminsky
  44  */
  45 public class PDLOverrideSupported extends EnumSyntax
  46     implements PrintServiceAttribute {
  47 
  48     /**
  49      * Use serialVersionUID from JDK 1.4 for interoperability.
  50      */
  51     private static final long serialVersionUID = -4393264467928463934L;
  52 
  53     /**
  54      * The printer makes no attempt to make the external job attribute values
  55      * take precedence over embedded instructions in the documents' print data.
  56      */
  57     public static final PDLOverrideSupported
  58         NOT_ATTEMPTED = new PDLOverrideSupported(0);
  59 
  60     /**
  61      * The printer attempts to make the external job attribute values take
  62      * precedence over embedded instructions in the documents' print data,
  63      * however there is no guarantee.
  64      */
  65     public static final PDLOverrideSupported
  66         ATTEMPTED = new PDLOverrideSupported(1);
  67 
  68     /**
  69      * Construct a new PDL override supported enumeration value with the given
  70      * integer value.
  71      *
  72      * @param  value Integer value
  73      */
  74     protected PDLOverrideSupported(int value) {
  75         super (value);
  76     }
  77 
  78     /**
  79      * The string table for class {@code PDLOverrideSupported}.
  80      */
  81     private static final String[] myStringTable = {
  82         "not-attempted",
  83         "attempted"
  84     };
  85 
  86     /**
  87      * The enumeration value table for class {@code PDLOverrideSupported}.
  88      */
  89     private static final PDLOverrideSupported[] myEnumValueTable = {
  90         NOT_ATTEMPTED,
  91         ATTEMPTED
  92     };
  93 
  94     /**
  95      * Returns the string table for class {@code PDLOverrideSupported}.
  96      */
  97     protected String[] getStringTable() {
  98         return myStringTable.clone();
  99     }
 100 
 101     /**
 102      * Returns the enumeration value table for class
 103      * {@code PDLOverrideSupported}.
 104      */
 105     protected EnumSyntax[] getEnumValueTable() {
 106         return (EnumSyntax[])myEnumValueTable.clone();
 107     }
 108 
 109     /**
 110      * Get the printing attribute class which is to be used as the "category"
 111      * for this printing attribute value.
 112      * <p>
 113      * For class {@code PDLOverrideSupported} and any vendor-defined subclasses,
 114      * the category is class {@code PDLOverrideSupported} itself.
 115      *
 116      * @return printing attribute class (category), an instance of class
 117      *         {@link Class java.lang.Class}
 118      */
 119     public final Class<? extends Attribute> getCategory() {
 120         return PDLOverrideSupported.class;
 121     }
 122 
 123     /**
 124      * Get the name of the category of which this attribute value is an
 125      * instance.
 126      * <p>
 127      * For class {@code PDLOverrideSupported} and any vendor-defined subclasses,
 128      * the category name is {@code "pdl-override-supported"}.
 129      *
 130      * @return attribute category name
 131      */
 132     public final String getName() {
 133         return "pdl-override-supported";
 134     }
 135 }