/*
* Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.print.attribute.standard;
import javax.print.attribute.Attribute;
import javax.print.attribute.EnumSyntax;
import javax.print.attribute.DocAttribute;
import javax.print.attribute.PrintRequestAttribute;
import javax.print.attribute.PrintJobAttribute;
/**
* Class Chromaticity is a printing attribute class, an enumeration, that
* specifies monochrome or color printing. This is used by a print client
* to specify how the print data should be generated or processed. It is not
* descriptive of the color capabilities of the device. Query the service's
* {@link ColorSupported ColorSupported} attribute to determine if the device
* can be verified to support color printing.
* <P>
* The table below shows the effects of specifying a Chromaticity attribute of
* {@link #MONOCHROME <CODE>MONOCHROME</CODE>} or {@link #COLOR
* <CODE>COLOR</CODE>} for a monochrome or color document.
* <P>
* <TABLE BORDER=1 CELLPADDING=2 CELLSPACING=1 SUMMARY="Shows effects of specifying MONOCHROME or COLOR Chromaticity attributes">
* <TR BGCOLOR="#E5E5E5">
* <TH>
* Chromaticity<BR>Attribute
* </TH>
* <TH>
* Effect on<BR>Monochrome Document
* </TH>
* <TH>
* Effect on<BR>Color Document
* </TH>
* </TR>
* <TR>
* <TD>
* {@link #MONOCHROME <CODE>MONOCHROME</CODE>}
* </TD>
* <TD>
* Printed as is, in monochrome
* </TD>
* <TD>
* Printed in monochrome, with colors converted to shades of gray
* </TD>
* </TR>
* <TR>
* <TD>
* {@link #COLOR <CODE>COLOR</CODE>}
* </TD>
* <TD>
* Printed as is, in monochrome
* </TD>
* <TD>
* Printed as is, in color
* </TD>
* </TR>
* </TABLE>
* <P>
* <P>
* <B>IPP Compatibility:</B> Chromaticity is not an IPP attribute at present.
* <P>
*
* @author Alan Kaminsky
*/
public final class Chromaticity extends EnumSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
private static final long serialVersionUID = 4660543931355214012L;
/**
* Monochrome printing.
*/
public static final Chromaticity MONOCHROME = new Chromaticity(0);
/**
* Color printing.
*/
public static final Chromaticity COLOR = new Chromaticity(1);
/**
* Construct a new chromaticity enumeration value with the given integer
* value.
*
* @param value Integer value.
*/
protected Chromaticity(int value) {
super(value);
}
private static final String[] myStringTable = {"monochrome",
"color"};
private static final Chromaticity[] myEnumValueTable = {MONOCHROME,
COLOR};
/**
* Returns the string table for class Chromaticity.
*/
protected String[] getStringTable() {
return myStringTable;
}
/**
* Returns the enumeration value table for class Chromaticity.
*/
protected EnumSyntax[] getEnumValueTable() {
return myEnumValueTable;
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* <P>
* For class Chromaticity, the category is the class Chromaticity itself.
*
* @return Printing attribute class (category), an instance of class
* {@link java.lang.Class java.lang.Class}.
*/
public final Class<? extends Attribute> getCategory() {
return Chromaticity.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
* <P>
* For class Chromaticity, the category name is <CODE>"chromaticity"</CODE>.
*
* @return Attribute category name.
*/
public final String getName() {
return "chromaticity";
}
}