1 /*
   2  * Copyright (c) 2000, 2017, 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 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.EnumSyntax;
  30 
  31 /**
  32  * Class {@code MediaTray} is a subclass of {@code Media}. Class
  33  * {@code MediaTray} is a printing attribute class, an enumeration, that
  34  * specifies the media tray or bin for the job. This attribute can be used
  35  * instead of specifying {@code MediaSize} or {@code MediaName}.
  36  * <p>
  37  * Class {@code MediaTray} declares keywords for standard media kind values.
  38  * Implementation- or site-defined names for a media kind attribute may also be
  39  * created by defining a subclass of class {@code MediaTray}.
  40  * <p>
  41  * <b>IPP Compatibility:</b> {@code MediaTray} is a representation class for
  42  * values of the IPP "media" attribute which name paper trays.
  43  */
  44 public class MediaTray extends Media implements Attribute {
  45 
  46     /**
  47      * Use serialVersionUID from JDK 1.4 for interoperability.
  48      */
  49     private static final long serialVersionUID = -982503611095214703L;
  50 
  51     /**
  52      * The top input tray in the printer.
  53      */
  54     public static final MediaTray TOP = new MediaTray(0);
  55 
  56     /**
  57      * The middle input tray in the printer.
  58      */
  59     public static final MediaTray MIDDLE = new MediaTray(1);
  60 
  61     /**
  62      * The bottom input tray in the printer.
  63      */
  64     public static final MediaTray BOTTOM = new MediaTray(2);
  65 
  66     /**
  67      * The envelope input tray in the printer.
  68      */
  69     public static final MediaTray ENVELOPE = new MediaTray(3);
  70 
  71     /**
  72      * The manual feed input tray in the printer.
  73      */
  74     public static final MediaTray MANUAL = new MediaTray(4);
  75 
  76     /**
  77      * The large capacity input tray in the printer.
  78      */
  79     public static final MediaTray LARGE_CAPACITY = new MediaTray(5);
  80 
  81     /**
  82      * The main input tray in the printer.
  83      */
  84     public static final MediaTray MAIN = new MediaTray(6);
  85 
  86     /**
  87      * The side input tray.
  88      */
  89     public static final MediaTray SIDE = new MediaTray(7);
  90 
  91     /**
  92      * Construct a new media tray enumeration value with the given integer
  93      * value.
  94      *
  95      * @param  value Integer value
  96      */
  97     protected MediaTray(int value) {
  98         super (value);
  99     }
 100 
 101     /**
 102      * The string table for class {@code MediaTray}.
 103      */
 104     private static final String[] myStringTable ={
 105         "top",
 106         "middle",
 107         "bottom",
 108         "envelope",
 109         "manual",
 110         "large-capacity",
 111         "main",
 112         "side"
 113     };
 114 
 115     /**
 116      * The enumeration value table for class {@code MediaTray}.
 117      */
 118     private static final MediaTray[] myEnumValueTable = {
 119         TOP,
 120         MIDDLE,
 121         BOTTOM,
 122         ENVELOPE,
 123         MANUAL,
 124         LARGE_CAPACITY,
 125         MAIN,
 126         SIDE
 127     };
 128 
 129     /**
 130      * Returns the string table for class {@code MediaTray}.
 131      */
 132     protected String[] getStringTable()
 133     {
 134         return myStringTable.clone();
 135     }
 136 
 137     /**
 138      * Returns the enumeration value table for class {@code MediaTray}.
 139      */
 140     protected EnumSyntax[] getEnumValueTable() {
 141         return (EnumSyntax[])myEnumValueTable.clone();
 142     }
 143 }