1 /*
   2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.util.Locale;
  28 
  29 import javax.print.attribute.Attribute;
  30 import javax.print.attribute.EnumSyntax;
  31 
  32 
  33 /**
  34  * Class MediaTray is a subclass of Media.
  35  * Class MediaTray is a printing attribute class, an enumeration, that
  36  * specifies the media tray or bin for the job.
  37  * This attribute can be used instead of specifying MediaSize or MediaName.
  38  * <p>
  39  * Class MediaTray declares keywords for standard media kind values.
  40  * Implementation- or site-defined names for a media kind attribute may also
  41  * be created by defining a subclass of class MediaTray.
  42  * <P>
  43  * <B>IPP Compatibility:</B> MediaTray is a representation class for
  44  * values of the IPP "media" attribute which name paper trays.
  45  */
  46 public class MediaTray extends Media implements Attribute {
  47 
  48     private static final long serialVersionUID = -982503611095214703L;
  49 
  50     /**
  51      * The top input tray in the printer.
  52      */
  53     public static final MediaTray TOP = new MediaTray(0);
  54 
  55     /**
  56      * The middle input tray in the printer.
  57      */
  58     public static final MediaTray MIDDLE = new MediaTray(1);
  59 
  60     /**
  61      * The bottom input tray in the printer.
  62      */
  63     public static final MediaTray BOTTOM = new MediaTray(2);
  64 
  65     /**
  66      * The envelope input tray in the printer.
  67      */
  68     public static final MediaTray ENVELOPE = new MediaTray(3);
  69 
  70     /**
  71      * The manual feed input tray in the printer.
  72      */
  73     public static final MediaTray MANUAL = new MediaTray(4);
  74 
  75     /**
  76      * The large capacity input tray in the printer.
  77      */
  78     public static final MediaTray LARGE_CAPACITY = new MediaTray(5);
  79 
  80     /**
  81      * The main input tray in the printer.
  82      */
  83     public static final MediaTray MAIN = new MediaTray(6);
  84 
  85     /**
  86      * The side input tray.
  87      */
  88     public static final MediaTray SIDE = new MediaTray(7);
  89 
  90     /**
  91      * Construct a new media tray enumeration value with the given integer
  92      * value.
  93      *
  94      * @param  value  Integer value.
  95      */
  96     protected MediaTray(int value) {
  97         super (value);
  98     }
  99 
 100     private static final String[] myStringTable ={
 101         "top",
 102         "middle",
 103         "bottom",
 104         "envelope",
 105         "manual",
 106         "large-capacity",
 107         "main",
 108         "side"
 109     };
 110 
 111     private static final MediaTray[] myEnumValueTable = {
 112         TOP,
 113         MIDDLE,
 114         BOTTOM,
 115         ENVELOPE,
 116         MANUAL,
 117         LARGE_CAPACITY,
 118         MAIN,
 119         SIDE
 120     };
 121 
 122     /**
 123      * Returns the string table for class MediaTray.
 124      */
 125     protected String[] getStringTable()
 126     {
 127         return (String[])myStringTable.clone();
 128     }
 129 
 130     /**
 131      * Returns the enumeration value table for class MediaTray.
 132      */
 133     protected EnumSyntax[] getEnumValueTable() {
 134         return (EnumSyntax[])myEnumValueTable.clone();
 135     }
 136 
 137 
 138 }