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 java.util.Locale;
028
029 import javax.print.attribute.Attribute;
030 import javax.print.attribute.TextSyntax;
031 import javax.print.attribute.PrintRequestAttribute;
032 import javax.print.attribute.PrintJobAttribute;
033
034 /**
035 * Class JobName is a printing attribute class, a text attribute, that specifies
036 * the name of a print job. A job's name is an arbitrary string defined by the
037 * client. It does not need to be unique between different jobs. A Print Job's
038 * JobName attribute is set to the value supplied by the client in the Print
039 * Request's attribute set. If, however, the client does not supply a JobName
040 * attribute in the Print Request, the printer, when it creates the Print Job,
041 * must generate a JobName. The printer should generate the value of the Print
042 * Job's JobName attribute from the first of the following sources that produces
043 * a value: (1) the {@link DocumentName DocumentName} attribute of the first (or
044 * only) doc in the job, (2) the URL of the first (or only) doc in the job, if
045 * the doc's print data representation object is a URL, or (3) any other piece
046 * of Print Job specific and/or document content information.
047 * <P>
048 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
049 * locale gives the IPP natural language. The category name returned by
050 * <CODE>getName()</CODE> gives the IPP attribute name.
051 * <P>
052 *
053 * @author Alan Kaminsky
054 */
055 public final class JobName extends TextSyntax implements
056 PrintRequestAttribute, PrintJobAttribute {
057
058 private static final long serialVersionUID = 4660359192078689545L;
059
060 /**
061 * Constructs a new job name attribute with the given job name and locale.
062 *
063 * @param jobName Job name.
064 * @param locale Natural language of the text string. null
065 * is interpreted to mean the default locale as returned
066 * by <code>Locale.getDefault()</code>
067 *
068 * @exception NullPointerException
069 * (unchecked exception) Thrown if <CODE>jobName</CODE> is null.
070 */
071 public JobName(String jobName, Locale locale) {
072 super (jobName, locale);
073 }
074
075 /**
076 * Returns whether this job name attribute is equivalent to the passed in
077 * object. To be equivalent, all of the following conditions must be true:
078 * <OL TYPE=1>
079 * <LI>
080 * <CODE>object</CODE> is not null.
081 * <LI>
082 * <CODE>object</CODE> is an instance of class JobName.
083 * <LI>
084 * This job name attribute's underlying string and <CODE>object</CODE>'s
085 * underlying string are equal.
086 * <LI>
087 * This job name attribute's locale and <CODE>object</CODE>'s locale are
088 * equal.
089 * </OL>
090 *
091 * @param object Object to compare to.
092 *
093 * @return True if <CODE>object</CODE> is equivalent to this job name
094 * attribute, false otherwise.
095 */
096 public boolean equals(Object object) {
097 return (super .equals(object) && object instanceof JobName);
098 }
099
100 /**
101 * Get the printing attribute class which is to be used as the "category"
102 * for this printing attribute value.
103 * <P>
104 * For class JobName, the category is class JobName itself.
105 *
106 * @return Printing attribute class (category), an instance of class
107 * {@link java.lang.Class java.lang.Class}.
108 */
109 public final Class<? extends Attribute> getCategory() {
110 return JobName.class;
111 }
112
113 /**
114 * Get the name of the category of which this attribute value is an
115 * instance.
116 * <P>
117 * For class JobName, the category name is <CODE>"job-name"</CODE>.
118 *
119 * @return Attribute category name.
120 */
121 public final String getName() {
122 return "job-name";
123 }
124
125 }
|