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

   1 /* Sides.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.DocAttribute;
  41 import javax.print.attribute.EnumSyntax;
  42 import javax.print.attribute.PrintJobAttribute;
  43 import javax.print.attribute.PrintRequestAttribute;
  44
  45
  46 /**
  47  * The <code>Sides</code> printing attribute specifies how consecutive
  48  * printing pages are arranged on the media sheet.
  49  * <p>
  50  * <b>IPP Compatibility:</b> Sides is an IPP 1.1 attribute.
  51  * </p>
  52  *
  53  * @author Michael Koch (konqueror@gmx.de)
  54  * @author Wolfgang Baer (WBaer@gmx.de)
  55  */
  56 public final class Sides extends EnumSyntax
  57   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  58 {
  59   private static final long serialVersionUID = -6890309414893262822L;
  60
  61   /**
  62    * Specifies that each page should be printed on one sheet.
  63    */
  64   public static final Sides ONE_SIDED = new Sides(0);
  65
  66   /**
  67    * Specifies that two following pages should be printed on the
  68    * front and back of one sheet for binding on the long edge.
  69    */
  70   public static final Sides TWO_SIDED_LONG_EDGE = new Sides(1);
  71
  72   /**
  73    * Specifies that two following pages should be printed on the
  74    * front and back of one sheet for binding on the short edge.
  75    */
  76   public static final Sides TWO_SIDED_SHORT_EDGE = new Sides(2);
  77
  78   /**
  79    * An alias constant for "two sided long edge".
  80    */
  81   public static final Sides DUPLEX = new Sides(1);
  82
  83   /**
  84    * An alias constant for "two sided short edge".
  85    */
  86   public static final Sides TUMBLE = new Sides(2);
  87
  88   private static final String[] stringTable = { "one-sided",
  89                                                 "two-sided-long-edge",
  90                                                 "two-sided-short-edge" };
  91
  92   private static final Sides[] enumValueTable = { ONE_SIDED,
  93                                                   TWO_SIDED_LONG_EDGE,
  94                                                   TWO_SIDED_SHORT_EDGE };
  95
  96   /**
  97    * Creates a <code>Sides</code> object.
  98    *
  99    * @param value the number of sides
 100    */
 101   protected Sides(int value)
 102   {
 103     super(value);
 104   }
 105
 106   /**
 107    * Returns category of this class.
 108    *
 109    * @return The class <code>Sides</code> itself.
 110    */
 111   public Class getCategory()
 112   {
 113     return Sides.class;
 114   }
 115
 116   /**
 117    * Returns the name of this attribute.
 118    *
 119    * @return The name "sides".
 120    */
 121   public String getName()
 122   {
 123     return "sides";
 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 }