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

   1 /* MediaTray.java --
   2    Copyright (C) 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.EnumSyntax;
  41
  42 /**
  43  * <code>MediaTray</code> is a subclass of the <code>Media</code> printing
  44  * attribute and provides selection of media to be used by the means of the
  45  * input tray of the printer. The class pre-defines commonly available types
  46  * of input trays in printers. This media type enumeration may be used in
  47  * alternative to MediaSizeName/MediaName.
  48  * <p>
  49  * <b>IPP Compatibility:</b> MediaTray is not an IPP 1.1 attribute on its own.
  50  * It provides parts of the <code>media</code> attribute type values.
  51  * </p>
  52  *
  53  * @author Sven de Marothy
  54  * @author Wolfgang Baer (WBaer@gmx.de)
  55  */
  56 public class MediaTray extends Media
  57 {
  58
  59   private static final long serialVersionUID = -982503611095214703L;
  60
  61   /**
  62    * Top tray
  63    */
  64   public static final MediaTray TOP = new MediaTray(0);
  65
  66   /**
  67    * Middle tray
  68    */
  69   public static final MediaTray MIDDLE = new MediaTray(1);
  70
  71   /**
  72    * Bottom tray
  73    */
  74   public static final MediaTray BOTTOM = new MediaTray(2);
  75
  76   /**
  77    * Envelope tray
  78    */
  79   public static final MediaTray ENVELOPE = new MediaTray(3);
  80
  81   /**
  82    * Manual-feed tray
  83    */
  84   public static final MediaTray MANUAL = new MediaTray(4);
  85
  86   /**
  87    * Large capacity tray
  88    */
  89   public static final MediaTray LARGE_CAPACITY = new MediaTray(5);
  90
  91   /**
  92    * Main tray
  93    */
  94   public static final MediaTray MAIN = new MediaTray(6);
  95
  96   /**
  97    * Side tray
  98    */
  99   public static final MediaTray SIDE = new MediaTray(7);
 100
 101   private static final String[] stringTable = { "top", "middle", "bottom",
 102                                                 "envelope", "manual",
 103                                                 "large-capacity", "main",
 104                                                 "side" };
 105
 106   private static final MediaTray[] enumValueTable = { TOP, MIDDLE, BOTTOM,
 107                                                       ENVELOPE, MANUAL,
 108                                                       LARGE_CAPACITY, MAIN,
 109                                                       SIDE };
 110
 111   /**
 112    * Creates a <code>MediaTray</code> object.
 113    *
 114    * @param i the enum value.
 115    */
 116   protected MediaTray(int i)
 117   {
 118     super( i );
 119   }
 120
 121   /**
 122    * Returns a table with the enumeration values represented as strings
 123    * for this object.
 124    *
 125    * @return The enumeration values as strings.
 126    */
 127   protected String[] getStringTable()
 128   {
 129     return stringTable;
 130   }
 131
 132   /**
 133    * Returns a table with the enumeration values for this object.
 134    *
 135    * @return The enumeration values.
 136    */
 137   protected EnumSyntax[] getEnumValueTable()
 138   {
 139     return enumValueTable;
 140   }
 141 }
 142