001    /* Fidelity.java --
002       Copyright (C) 2004, 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version.  */
037    
038    
039    package javax.print.attribute.standard;
040    
041    import javax.print.attribute.Attribute;
042    import javax.print.attribute.EnumSyntax;
043    import javax.print.attribute.PrintJobAttribute;
044    import javax.print.attribute.PrintRequestAttribute;
045    
046    
047    /**
048     * The <code>Fidelity</code> attribute specifies how a print job is handled
049     * if the supplied attributes are not fully supported.
050     * <p>
051     * There may be conflicts between the client requested attributes and the
052     * attributes supported by the printer object. Such situations are controlled
053     * through the client by providing this attribute to indicate the wanted
054     * conflict handling mechanism:
055     * <ul>
056     * <li>{@link #FIDELITY_TRUE}: Reject the job since the job can not be 
057     * processed exactly as specified by the attributes of the client.</li>
058     * <li>{@link #FIDELITY_FALSE}: The Printer may make any changes necessary 
059     * to proceed with processing the Job as good as possible.</li>
060     * </ul>
061     * </p> 
062     * <p>
063     * <b>IPP Compatibility:</b> Fidelity is an IPP 1.1 attribute. The IPP name
064     * is "ipp-attribute-fidelity". The IPP specification treats Fidelity as a 
065     * boolean type which is not available in the Java Print Service API. The IPP
066     * boolean value "true" corresponds to <code>FIDELITY_TRUE</code> and "false" 
067     * to <code>FIDELITY_FALSE</code>.
068     * </p>
069     * 
070     * @author Michael Koch (konqueror@gmx.de)
071     * @author Wolfgang Baer (WBaer@gmx.de)
072     */
073    public final class Fidelity extends EnumSyntax
074      implements PrintJobAttribute, PrintRequestAttribute
075    {
076      private static final long serialVersionUID = 6320827847329172308L;
077    
078      /** 
079       * Requests that the job is printed exactly as specified, 
080       * or rejected otherwise.
081       */
082      public static final Fidelity FIDELITY_TRUE = new Fidelity(0);
083      
084      /** 
085       * Requests that the job is printed as exactly as reasonable. This means
086       * that the print service may choose to substitute the default value 
087       * associated with that attribute, or use some other supported value that 
088       * is similar to the unsupported requested value. 
089       */
090      public static final Fidelity FIDELITY_FALSE = new Fidelity(1);
091      
092      private static final String[] stringTable = { "true", "false" };
093      private static final Fidelity[] enumValueTable = { FIDELITY_TRUE,
094                                                         FIDELITY_FALSE };
095    
096      /**
097       * Constructs a <code>Fidelity</code> object.
098       * 
099       * @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    }