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

   1 /* Media.java --
   2    Copyright (C) 2004, 2005, 2006 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.Attribute;
  41 import javax.print.attribute.DocAttribute;
  42 import javax.print.attribute.EnumSyntax;
  43 import javax.print.attribute.PrintJobAttribute;
  44 import javax.print.attribute.PrintRequestAttribute;
  45
  46
  47 /**
  48  * The <code>Media</code> printing attribute specifies which
  49  * type of media should be used for printing.
  50  * <p>
  51  * The media to be used can be specified in three ways represented
  52  * by the media subclasses {@link javax.print.attribute.standard.MediaTray},
  53  * {@link javax.print.attribute.standard.MediaName} and
  54  * {@link javax.print.attribute.standard.MediaSizeName}:
  55  * <ul>
  56  * <li>Selection by paper source - selection of printer tray to be used.</li>
  57  * <li>Selection by name - e.g. A4 paper.</li>
  58  * <li>Selection by standard sizes - e.g. ISO A5, JIS B4.</li>
  59  * </ul>
  60  * Each of the sublcasses represents the IPP attribute <code>media</code>
  61  * and provides predefined values to be used.
  62  * </p>
  63  * <p>
  64  * <b>IPP Compatibility:</b> Media is an IPP 1.1 attribute.
  65  * </p>
  66  *
  67  * @author Michael Koch (konqueror@gmx.de)
  68  * @author Wolfgang Baer (WBaer@gmx.de)
  69  */
  70 public abstract class Media extends EnumSyntax
  71   implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
  72 {
  73   private static final long serialVersionUID = -2823970704630722439L;
  74
  75   /**
  76    * Constructs a <code>Media</code> object.
  77    *
  78    * @param value the enum value.
  79    */
  80   protected Media(int value)
  81   {
  82     super(value);
  83   }
  84
  85   /**
  86    * Tests if the given object is equal to this object.
  87    * The objects are considered equal if both are of the same
  88    * Media subclass, not null and the values are equal.
  89    *
  90    * @param obj the object to test
  91    *
  92    * @return <code>true</code> if both objects are equal,
  93    * <code>false</code> otherwise.
  94    */
  95   public boolean equals(Object obj)
  96   {
  97     if (obj == null)
  98       return false;
  99
 100     return (obj.getClass() == this.getClass()
 101             && ((Media) obj).getValue() == this.getValue());
 102   }
 103
 104   /**
 105    * Returns category of this class.
 106    *
 107    * @return The class <code>Media</code> itself.
 108    */
 109   public Class< ? extends Attribute> getCategory()
 110   {
 111     return Media.class;
 112   }
 113
 114   /**
 115    * Returns the name of this attribute.
 116    *
 117    * @return The name "media".
 118    */
 119   public final String getName()
 120   {
 121     return "media";
 122   }
 123 }