001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.DocAttribute;
029 import javax.print.attribute.EnumSyntax;
030 import javax.print.attribute.PrintRequestAttribute;
031 import javax.print.attribute.PrintJobAttribute;
032
033 /**
034 * Class Media is a printing attribute class that specifies the
035 * medium on which to print.
036 * <p>
037 * Media may be specified in different ways.
038 * <ul>
039 * <li> it may be specified by paper source - eg paper tray
040 * <li> it may be specified by a standard size - eg "A4"
041 * <li> it may be specified by a name - eg "letterhead"
042 * </ul>
043 * Each of these corresponds to the IPP "media" attribute.
044 * The current API does not support describing media by characteristics
045 * (eg colour, opacity).
046 * This may be supported in a later revision of the specification.
047 * <p>
048 * A Media object is constructed with a value which represents
049 * one of the ways in which the Media attribute can be specified.
050 * <p>
051 * <B>IPP Compatibility:</B> The category name returned by
052 * <CODE>getName()</CODE> is the IPP attribute name. The enumeration's
053 * integer value is the IPP enum value. The <code>toString()</code> method
054 * returns the IPP string representation of the attribute value.
055 * <P>
056 *
057 * @author Phil Race
058 */
059 public abstract class Media extends EnumSyntax implements DocAttribute,
060 PrintRequestAttribute, PrintJobAttribute {
061
062 private static final long serialVersionUID = -2823970704630722439L;
063
064 /**
065 * Constructs a new media attribute specified by name.
066 *
067 * @param value a value
068 */
069 protected Media(int value) {
070 super (value);
071 }
072
073 /**
074 * Returns whether this media attribute is equivalent to the passed in
075 * object. To be equivalent, all of the following conditions must be true:
076 * <OL TYPE=1>
077 * <LI>
078 * <CODE>object</CODE> is not null.
079 * <LI>
080 * <CODE>object</CODE> is of the same subclass of Media as this object.
081 * <LI>
082 * The values are equal.
083 * </OL>
084 *
085 * @param object Object to compare to.
086 *
087 * @return True if <CODE>object</CODE> is equivalent to this media
088 * attribute, false otherwise.
089 */
090 public boolean equals(Object object) {
091 return (object != null && object instanceof Media
092 && object.getClass() == this .getClass() && ((Media) object)
093 .getValue() == this .getValue());
094 }
095
096 /**
097 * Get the printing attribute class which is to be used as the "category"
098 * for this printing attribute value.
099 * <P>
100 * For class Media and any vendor-defined subclasses, the category is
101 * class Media itself.
102 *
103 * @return Printing attribute class (category), an instance of class
104 * {@link java.lang.Class java.lang.Class}.
105 */
106 public final Class<? extends Attribute> getCategory() {
107 return Media.class;
108 }
109
110 /**
111 * Get the name of the category of which this attribute value is an
112 * instance.
113 * <P>
114 * For class Media and any vendor-defined subclasses, the category name is
115 * <CODE>"media"</CODE>.
116 *
117 * @return Attribute category name.
118 */
119 public final String getName() {
120 return "media";
121 }
122
123 }
|