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 ColorSupported is a printing attribute class, an enumeration, that
033 * identifies whether the device is capable of any type of color printing at
034 * all, including highlight color as well as full process color. All document
035 * instructions having to do with color are embedded within the print data (none
036 * are attributes attached to the job outside the print data).
037 * <P>
038 * Note: End users are able to determine the nature and details of the color
039 * support by querying the {@link PrinterMoreInfoManufacturer
040 * PrinterMoreInfoManufacturer} attribute.
041 * <P>
042 * Don't confuse the ColorSupported attribute with the {@link Chromaticity
043 * Chromaticity} attribute. {@link Chromaticity Chromaticity} is an attribute
044 * the client can specify for a job to tell the printer whether to print a
045 * document in monochrome or color, possibly causing the printer to print a
046 * color document in monochrome. ColorSupported is a printer description
047 * attribute that tells whether the printer can print in color regardless of how
048 * the client specifies to print any particular document.
049 * <P>
050 * <B>IPP Compatibility:</B> The IPP boolean value is "true" for SUPPORTED and
051 * "false" for NOT_SUPPORTED. The category name returned by
052 * <CODE>getName()</CODE> is the IPP attribute name. The enumeration's
053 * integer value is the IPP enum value. The <code>toString()</code> method
054 * returns the IPP string representation of the attribute value.
055 * <P>
056 *
057 * @author Alan Kaminsky
058 */
059 public final class ColorSupported extends EnumSyntax implements
060 PrintServiceAttribute {
061
062 private static final long serialVersionUID = -2700555589688535545L;
063
064 /**
065 * The printer is not capable of any type of color printing.
066 */
067 public static final ColorSupported NOT_SUPPORTED = new ColorSupported(
068 0);
069
070 /**
071 * The printer is capable of some type of color printing, such as
072 * highlight color or full process color.
073 */
074 public static final ColorSupported SUPPORTED = new ColorSupported(1);
075
076 /**
077 * Construct a new color supported enumeration value with the given
078 * integer value.
079 *
080 * @param value Integer value.
081 */
082 protected ColorSupported(int value) {
083 super (value);
084 }
085
086 private static final String[] myStringTable = { "not-supported",
087 "supported" };
088
089 private static final ColorSupported[] myEnumValueTable = {
090 NOT_SUPPORTED, SUPPORTED };
091
092 /**
093 * Returns the string table for class ColorSupported.
094 */
095 protected String[] getStringTable() {
096 return myStringTable;
097 }
098
099 /**
100 * Returns the enumeration value table for class ColorSupported.
101 */
102 protected EnumSyntax[] getEnumValueTable() {
103 return myEnumValueTable;
104 }
105
106 /**
107 * Get the printing attribute class which is to be used as the "category"
108 * for this printing attribute value.
109 * <P>
110 * For class ColorSupported, the category is class ColorSupported itself.
111 *
112 * @return Printing attribute class (category), an instance of class
113 * {@link java.lang.Class java.lang.Class}.
114 */
115 public final Class<? extends Attribute> getCategory() {
116 return ColorSupported.class;
117 }
118
119 /**
120 * Get the name of the category of which this attribute value is an
121 * instance.
122 * <P>
123 * For class ColorSupported, the category name is <CODE>"color-supported"</CODE>.
124 *
125 * @return Attribute category name.
126 */
127 public final String getName() {
128 return "color-supported";
129 }
130
131 }
|