Source for javax.print.attribute.standard.SheetCollate

   1: /* SheetCollate.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: package javax.print.attribute.standard;
  39: 
  40: import javax.print.attribute.DocAttribute;
  41: import javax.print.attribute.EnumSyntax;
  42: import javax.print.attribute.PrintJobAttribute;
  43: import javax.print.attribute.PrintRequestAttribute;
  44: 
  45: 
  46: /**
  47:  * The <code>SheetCollate</code> printing attribute specifies 
  48:  * whether or not the sheets of each copy in a print job have to be
  49:  * in sequence.
  50:  * <p>
  51:  * The attribute only makes sense if multiple copies are specified through
  52:  * the <code>Copies</code> printing attribute. If <code>UNCOLLATED</code>
  53:  * is specified every page of a print job is printed for all requested
  54:  * copies before the next page is processed. <code>COLLATED</code> means
  55:  * that for every copy requested the pages have to be printed in sequence.
  56:  * </p>
  57:  * <p>
  58:  * <b>IPP Compatibility:</b> SheetCollate is not an IPP 1.1 attribute.
  59:  * </p>
  60:  * 
  61:  * @author Michael Koch (konqueror@gmx.de)
  62:  * @author Wolfgang Baer (WBaer@gmx.de)
  63:  */
  64: public final class SheetCollate extends EnumSyntax
  65:   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  66: {
  67:   private static final long serialVersionUID = 7080587914259873003L;
  68: 
  69:   /**
  70:    * The sheets of the different copies are uncollated.
  71:    */
  72:   public static final SheetCollate UNCOLLATED = new SheetCollate(0);
  73:   
  74:   /**
  75:    * The sheets of the different copies are collated.
  76:    */
  77:   public static final SheetCollate COLLATED = new SheetCollate(1);
  78: 
  79: 
  80:   private static final String[] stringTable = { "uncollated", "collated" };
  81:   
  82:   private static final SheetCollate[] enumValueTable = { UNCOLLATED, 
  83:                                                          COLLATED };  
  84:   
  85:   /**
  86:    * Creates a <code>SheetCollate</code> object.
  87:    *
  88:    * @param value the enum value.
  89:    */
  90:   protected SheetCollate(int value)
  91:   {
  92:     super(value);
  93:   }
  94: 
  95:   /**
  96:    * Returns category of this class.
  97:    *
  98:    * @return The class <code>SheetCollate</code> itself.
  99:    */
 100:   public Class getCategory()
 101:   {
 102:     return SheetCollate.class;
 103:   }
 104: 
 105:   /**
 106:    * Returns the name of this attribute.
 107:    *
 108:    * @return The name "sheet-collate".
 109:    */
 110:   public String getName()
 111:   {
 112:     return "sheet-collate";
 113:   }
 114:   
 115:   /**
 116:    * Returns a table with the enumeration values represented as strings
 117:    * for this object.
 118:    *
 119:    * @return The enumeration values as strings.
 120:    */
 121:   protected String[] getStringTable()
 122:   {
 123:     return stringTable;
 124:   }
 125: 
 126:   /**
 127:    * Returns a table with the enumeration values for this object.
 128:    *
 129:    * @return The enumeration values.
 130:    */
 131:   protected EnumSyntax[] getEnumValueTable()
 132:   {
 133:     return enumValueTable;
 134:   }
 135: }