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

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