001/* SheetCollate.java -- 002 Copyright (C) 2004, 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.print.attribute.standard; 039 040import javax.print.attribute.Attribute; 041import javax.print.attribute.DocAttribute; 042import javax.print.attribute.EnumSyntax; 043import javax.print.attribute.PrintJobAttribute; 044import javax.print.attribute.PrintRequestAttribute; 045 046 047/** 048 * The <code>SheetCollate</code> printing attribute specifies 049 * whether or not the sheets of each copy in a print job have to be 050 * in sequence. 051 * <p> 052 * The attribute only makes sense if multiple copies are specified through 053 * the <code>Copies</code> printing attribute. If <code>UNCOLLATED</code> 054 * is specified every page of a print job is printed for all requested 055 * copies before the next page is processed. <code>COLLATED</code> means 056 * that for every copy requested the pages have to be printed in sequence. 057 * </p> 058 * <p> 059 * <b>IPP Compatibility:</b> SheetCollate is not an IPP 1.1 attribute. 060 * </p> 061 * 062 * @author Michael Koch (konqueror@gmx.de) 063 * @author Wolfgang Baer (WBaer@gmx.de) 064 */ 065public final class SheetCollate extends EnumSyntax 066 implements DocAttribute, PrintRequestAttribute, PrintJobAttribute 067{ 068 private static final long serialVersionUID = 7080587914259873003L; 069 070 /** 071 * The sheets of the different copies are uncollated. 072 */ 073 public static final SheetCollate UNCOLLATED = new SheetCollate(0); 074 075 /** 076 * The sheets of the different copies are collated. 077 */ 078 public static final SheetCollate COLLATED = new SheetCollate(1); 079 080 081 private static final String[] stringTable = { "uncollated", "collated" }; 082 083 private static final SheetCollate[] enumValueTable = { UNCOLLATED, 084 COLLATED }; 085 086 /** 087 * Creates a <code>SheetCollate</code> object. 088 * 089 * @param value the enum value. 090 */ 091 protected SheetCollate(int value) 092 { 093 super(value); 094 } 095 096 /** 097 * Returns category of this class. 098 * 099 * @return The class <code>SheetCollate</code> itself. 100 */ 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 */ 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 */ 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 */ 132 protected EnumSyntax[] getEnumValueTable() 133 { 134 return enumValueTable; 135 } 136}