Source for javax.print.attribute.standard.MultipleDocumentHandling

   1: /* MultipleDocumentHandling.java --
   2:    Copyright (C) 2004, 2006 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.Attribute;
  41: import javax.print.attribute.EnumSyntax;
  42: import javax.print.attribute.PrintJobAttribute;
  43: import javax.print.attribute.PrintRequestAttribute;
  44: 
  45: 
  46: /**
  47:  * The <code>MultipleDocumentHandling</code> printing attribute controls
  48:  * how certain printing attributes affect printing in case of multiple 
  49:  * documents in a print job. This attribute is only relevant if a job 
  50:  * has multiple documents.
  51:  * <p>
  52:  * <b>IPP Compatibility:</b> MultipleDocumentHandling is an IPP 1.1 attribute.
  53:  * </p>
  54:  * 
  55:  * @author Michael Koch (konqueror@gmx.de)
  56:  * @author Wolfgang Baer (WBaer@gmx.de)
  57:  */
  58: public class MultipleDocumentHandling extends EnumSyntax
  59:   implements PrintJobAttribute, PrintRequestAttribute
  60: {
  61:   private static final long serialVersionUID = 8098326460746413466L;
  62: 
  63:   /** 
  64:    * Multiple documents are treated as a single document.
  65:    */
  66:   public static final MultipleDocumentHandling SINGLE_DOCUMENT =
  67:     new MultipleDocumentHandling(0);
  68:   
  69:   /** 
  70:    * Multiple documents are treated as uncollated copies.
  71:    */
  72:   public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES =
  73:     new MultipleDocumentHandling(1);
  74:   
  75:   /** 
  76:    * Multiple documents are treated as collated copies. 
  77:    */
  78:   public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES =
  79:     new MultipleDocumentHandling(2);
  80:   
  81:   /** 
  82:    * Multiple documents are treated so that every single document starts
  83:    * with a new sheet. 
  84:    */
  85:   public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET =
  86:     new MultipleDocumentHandling(3);
  87:   
  88:   private static final String[] stringTable = { "single-document", 
  89:                                                 "separate-documents-uncollated-copies",
  90:                                                 "separate-documents-collated-copies",
  91:                                                 "single-document-new-sheet" };
  92:   
  93:   private static final MultipleDocumentHandling[] enumValueTable = 
  94:     { SINGLE_DOCUMENT, SEPARATE_DOCUMENTS_UNCOLLATED_COPIES,
  95:       SEPARATE_DOCUMENTS_COLLATED_COPIES, SINGLE_DOCUMENT_NEW_SHEET};
  96: 
  97:   /**
  98:    * Constructs a <code>MultipleDocumentHandling</code> object.
  99:    * 
 100:    * @param value the enum value
 101:    */
 102:   protected MultipleDocumentHandling(int value)
 103:   {
 104:     super(value);
 105:   }
 106: 
 107:   /**
 108:    * Returns category of this class.
 109:    *
 110:    * @return The class <code>MultipleDocumentHandling</code> itself.
 111:    */
 112:   public Class< ? extends Attribute> getCategory()
 113:   {
 114:     return MultipleDocumentHandling.class;
 115:   }
 116: 
 117:   /**
 118:    * Returns the name of this attribute.
 119:    *
 120:    * @return The name "multiple-document-handling".
 121:    */
 122:   public final String getName()
 123:   {
 124:     return "multiple-document-handling";
 125:   }
 126:   
 127:   /**
 128:    * Returns a table with the enumeration values represented as strings
 129:    * for this object.
 130:    *
 131:    * @return The enumeration values as strings.
 132:    */
 133:   protected String[] getStringTable()
 134:   {
 135:     return stringTable;
 136:   }
 137: 
 138:   /**
 139:    * Returns a table with the enumeration values for this object.
 140:    *
 141:    * @return The enumeration values.
 142:    */
 143:   protected EnumSyntax[] getEnumValueTable()
 144:   {
 145:     return enumValueTable;
 146:   }
 147: }