libjava/classpath/javax/print/attribute/standard/Chromaticity.java

   1 /* Chromaticity.java --
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.print.attribute.standard;
  40
  41 import javax.print.attribute.Attribute;
  42 import javax.print.attribute.DocAttribute;
  43 import javax.print.attribute.EnumSyntax;
  44 import javax.print.attribute.PrintJobAttribute;
  45 import javax.print.attribute.PrintRequestAttribute;
  46
  47 /**
  48  * The <code>Chromaticity</code> printing attribute specifies if print data
  49  * should be printed in monochrome or color.
  50  * <p>
  51  * The attribute interacts with the document to be printed. If the document
  52  * to be printed is a monochrome document it will be printed monochrome
  53  * regardless of the value of this attribute category. However if it is a
  54  * color document supplying the attribute value <code>MONOCHROME</code>
  55  * will prepare the document to be printed in monochrome instead of color.
  56  * </p>
  57  * <p>
  58  * This printing attribute has nothing to do with the capabilities of the
  59  * printer device. To check if a specific printer service supports printing
  60  * in color you have to use the attribute
  61  * {@link javax.print.attribute.standard.ColorSupported}
  62  * </p>
  63  * <p>
  64  * <b>IPP Compatibility:</b> Chromaticity is not an IPP 1.1 attribute.
  65  * </p>
  66  *
  67  * @author Michael Koch (konqueror@gmx.de)
  68  */
  69 public final class Chromaticity extends EnumSyntax
  70   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  71 {
  72   private static final long serialVersionUID = 4660543931355214012L;
  73
  74   /** Specifies monochrome printing. */
  75   public static final Chromaticity MONOCHROME = new Chromaticity(0);
  76
  77   /** Specifies color printing. */
  78   public static final Chromaticity COLOR = new Chromaticity(1);
  79
  80   private static final String[] stringTable = { "monochrome", "color" };
  81   private static final Chromaticity[] enumValueTable = { MONOCHROME, COLOR };
  82
  83   /**
  84    * Creates a <code>Chromaticity</code> object.
  85    *
  86    * @param value the enum value
  87    */
  88   protected Chromaticity(int value)
  89   {
  90     super(value);
  91   }
  92
  93   /**
  94    * Returns category of this class.
  95    *
  96    * @return The class <code>Chromaticity</code> itself.
  97    */
  98   public Class< ? extends Attribute> getCategory()
  99   {
 100     return Chromaticity.class;
 101   }
 102
 103   /**
 104    * Returns the name of this attribute.
 105    *
 106    * @return The name "chromaticity".
 107    */
 108   public String getName()
 109   {
 110     return "chromaticity";
 111   }
 112
 113   /**
 114    * Returns a table with the enumeration values represented as strings
 115    * for this object.
 116    *
 117    * @return The enumeration values as strings.
 118    */
 119   protected String[] getStringTable()
 120   {
 121     return stringTable;
 122   }
 123
 124   /**
 125    * Returns a table with the enumeration values for this object.
 126    *
 127    * @return The enumeration values.
 128    */
 129   protected EnumSyntax[] getEnumValueTable()
 130   {
 131     return enumValueTable;
 132   }
 133
 134 }