001/* Media.java --
002   Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.attribute.standard;
039
040import javax.print.attribute.Attribute;
041import javax.print.attribute.DocAttribute;
042import javax.print.attribute.EnumSyntax;
043import javax.print.attribute.PrintJobAttribute;
044import javax.print.attribute.PrintRequestAttribute;
045
046
047/**
048 * The <code>Media</code> printing attribute specifies which
049 * type of media should be used for printing.
050 * <p>
051 * The media to be used can be specified in three ways represented
052 * by the media subclasses {@link javax.print.attribute.standard.MediaTray},
053 * {@link javax.print.attribute.standard.MediaName} and 
054 * {@link javax.print.attribute.standard.MediaSizeName}:
055 * <ul>
056 * <li>Selection by paper source - selection of printer tray to be used.</li>
057 * <li>Selection by name - e.g. A4 paper.</li>
058 * <li>Selection by standard sizes - e.g. ISO A5, JIS B4.</li>
059 * </ul>
060 * Each of the sublcasses represents the IPP attribute <code>media</code>
061 * and provides predefined values to be used.
062 * </p> 
063 * <p>
064 * <b>IPP Compatibility:</b> Media is an IPP 1.1 attribute.
065 * </p>
066 * 
067 * @author Michael Koch (konqueror@gmx.de)
068 * @author Wolfgang Baer (WBaer@gmx.de)
069 */
070public abstract class Media extends EnumSyntax
071  implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
072{
073  private static final long serialVersionUID = -2823970704630722439L;
074
075  /**
076   * Constructs a <code>Media</code> object.
077   * 
078   * @param value the enum value.
079   */
080  protected Media(int value)
081  {
082    super(value);
083  }
084    
085  /**
086   * Tests if the given object is equal to this object.
087   * The objects are considered equal if both are of the same
088   * Media subclass, not null and the values are equal.
089   *
090   * @param obj the object to test
091   *
092   * @return <code>true</code> if both objects are equal, 
093   * <code>false</code> otherwise.
094   */
095  public boolean equals(Object obj)
096  {
097    if (obj == null)
098      return false;
099    
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}