001/* MultipleDocumentHandling.java --
002   Copyright (C) 2004, 2006 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.EnumSyntax;
042import javax.print.attribute.PrintJobAttribute;
043import javax.print.attribute.PrintRequestAttribute;
044
045
046/**
047 * The <code>MultipleDocumentHandling</code> printing attribute controls
048 * how certain printing attributes affect printing in case of multiple
049 * documents in a print job. This attribute is only relevant if a job
050 * has multiple documents.
051 * <p>
052 * <b>IPP Compatibility:</b> MultipleDocumentHandling is an IPP 1.1 attribute.
053 * </p>
054 *
055 * @author Michael Koch (konqueror@gmx.de)
056 * @author Wolfgang Baer (WBaer@gmx.de)
057 */
058public class MultipleDocumentHandling extends EnumSyntax
059  implements PrintJobAttribute, PrintRequestAttribute
060{
061  private static final long serialVersionUID = 8098326460746413466L;
062
063  /**
064   * Multiple documents are treated as a single document.
065   */
066  public static final MultipleDocumentHandling SINGLE_DOCUMENT =
067    new MultipleDocumentHandling(0);
068
069  /**
070   * Multiple documents are treated as uncollated copies.
071   */
072  public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES =
073    new MultipleDocumentHandling(1);
074
075  /**
076   * Multiple documents are treated as collated copies.
077   */
078  public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES =
079    new MultipleDocumentHandling(2);
080
081  /**
082   * Multiple documents are treated so that every single document starts
083   * with a new sheet.
084   */
085  public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET =
086    new MultipleDocumentHandling(3);
087
088  private static final String[] stringTable = { "single-document",
089                                                "separate-documents-uncollated-copies",
090                                                "separate-documents-collated-copies",
091                                                "single-document-new-sheet" };
092
093  private static final MultipleDocumentHandling[] enumValueTable =
094    { SINGLE_DOCUMENT, SEPARATE_DOCUMENTS_UNCOLLATED_COPIES,
095      SEPARATE_DOCUMENTS_COLLATED_COPIES, SINGLE_DOCUMENT_NEW_SHEET};
096
097  /**
098   * Constructs a <code>MultipleDocumentHandling</code> object.
099   *
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}