JobName.java revision 0
0N/A * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 0N/A * published by the Free Software Foundation. Sun designates this 0N/A * particular file as subject to the "Classpath" exception as provided 0N/A * by Sun in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 0N/A * CA 95054 USA or visit www.sun.com if you need additional information or 0N/A * have any questions. 0N/A * Class JobName is a printing attribute class, a text attribute, that specifies 0N/A * the name of a print job. A job's name is an arbitrary string defined by the 0N/A * client. It does not need to be unique between different jobs. A Print Job's 0N/A * JobName attribute is set to the value supplied by the client in the Print 0N/A * Request's attribute set. If, however, the client does not supply a JobName 0N/A * attribute in the Print Request, the printer, when it creates the Print Job, 0N/A * must generate a JobName. The printer should generate the value of the Print 0N/A * Job's JobName attribute from the first of the following sources that produces 0N/A * a value: (1) the {@link DocumentName DocumentName} attribute of the first (or 0N/A * only) doc in the job, (2) the URL of the first (or only) doc in the job, if 0N/A * the doc's print data representation object is a URL, or (3) any other piece 0N/A * of Print Job specific and/or document content information. 0N/A * <B>IPP Compatibility:</B> The string value gives the IPP name value. The 0N/A * locale gives the IPP natural language. The category name returned by 0N/A * <CODE>getName()</CODE> gives the IPP attribute name. 0N/A * @author Alan Kaminsky * Constructs a new job name attribute with the given job name and locale. * @param jobName Job name. * @param locale Natural language of the text string. null * is interpreted to mean the default locale as returned * by <code>Locale.getDefault()</code> * @exception NullPointerException * (unchecked exception) Thrown if <CODE>jobName</CODE> is null. * Returns whether this job name attribute is equivalent to the passed in * object. To be equivalent, all of the following conditions must be true: * <CODE>object</CODE> is not null. * <CODE>object</CODE> is an instance of class JobName. * This job name attribute's underlying string and <CODE>object</CODE>'s * underlying string are equal. * This job name attribute's locale and <CODE>object</CODE>'s locale are * @param object Object to compare to. * @return True if <CODE>object</CODE> is equivalent to this job name * attribute, false otherwise. * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. * For class JobName, the category is class JobName itself. * @return Printing attribute class (category), an instance of class * {@link java.lang.Class java.lang.Class}. * Get the name of the category of which this attribute value is an * For class JobName, the category name is <CODE>"job-name"</CODE>. * @return Attribute category name.