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

   1 /* Fidelity.java --
   2    Copyright (C) 2004, 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.EnumSyntax;
  43 import javax.print.attribute.PrintJobAttribute;
  44 import javax.print.attribute.PrintRequestAttribute;
  45
  46
  47 /**
  48  * The <code>Fidelity</code> attribute specifies how a print job is handled
  49  * if the supplied attributes are not fully supported.
  50  * <p>
  51  * There may be conflicts between the client requested attributes and the
  52  * attributes supported by the printer object. Such situations are controlled
  53  * through the client by providing this attribute to indicate the wanted
  54  * conflict handling mechanism:
  55  * <ul>
  56  * <li>{@link #FIDELITY_TRUE}: Reject the job since the job can not be
  57  * processed exactly as specified by the attributes of the client.</li>
  58  * <li>{@link #FIDELITY_FALSE}: The Printer may make any changes necessary
  59  * to proceed with processing the Job as good as possible.</li>
  60  * </ul>
  61  * </p>
  62  * <p>
  63  * <b>IPP Compatibility:</b> Fidelity is an IPP 1.1 attribute. The IPP name
  64  * is "ipp-attribute-fidelity". The IPP specification treats Fidelity as a
  65  * boolean type which is not available in the Java Print Service API. The IPP
  66  * boolean value "true" corresponds to <code>FIDELITY_TRUE</code> and "false"
  67  * to <code>FIDELITY_FALSE</code>.
  68  * </p>
  69  *
  70  * @author Michael Koch (konqueror@gmx.de)
  71  * @author Wolfgang Baer (WBaer@gmx.de)
  72  */
  73 public final class Fidelity extends EnumSyntax
  74   implements PrintJobAttribute, PrintRequestAttribute
  75 {
  76   private static final long serialVersionUID = 6320827847329172308L;
  77
  78   /**
  79    * Requests that the job is printed exactly as specified,
  80    * or rejected otherwise.
  81    */
  82   public static final Fidelity FIDELITY_TRUE = new Fidelity(0);
  83
  84   /**
  85    * Requests that the job is printed as exactly as reasonable. This means
  86    * that the print service may choose to substitute the default value
  87    * associated with that attribute, or use some other supported value that
  88    * is similar to the unsupported requested value.
  89    */
  90   public static final Fidelity FIDELITY_FALSE = new Fidelity(1);
  91
  92   private static final String[] stringTable = { "true", "false" };
  93   private static final Fidelity[] enumValueTable = { FIDELITY_TRUE,
  94                                                      FIDELITY_FALSE };
  95
  96   /**
  97    * Constructs a <code>Fidelity</code> object.
  98    *
  99    * @param value the value
 100    */
 101   protected Fidelity(int value)
 102   {
 103     super(value);
 104   }
 105
 106   /**
 107    * Returns category of this class.
 108    *
 109    * @return The class <code>Fidelity</code> itself.
 110    */
 111   public Class< ? extends Attribute> getCategory()
 112   {
 113     return Fidelity.class;
 114   }
 115
 116   /**
 117    * Returns the name of this attribute.
 118    *
 119    * @return The name "ipp-attribute-fidelity".
 120    */
 121   public String getName()
 122   {
 123     return "ipp-attribute-fidelity";
 124   }
 125
 126   /**
 127    * Returns a table with the enumeration values represented as strings
 128    * for this object.
 129    *
 130    * @return The enumeration values as strings.
 131    */
 132   protected String[] getStringTable()
 133   {
 134     return stringTable;
 135   }
 136
 137   /**
 138    * Returns a table with the enumeration values for this object.
 139    *
 140    * @return The enumeration values.
 141    */
 142   protected EnumSyntax[] getEnumValueTable()
 143   {
 144     return enumValueTable;
 145   }
 146 }