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