1: /* DocumentName.java -- 2: Copyright (C) 2004, 2005 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: 39: package javax.print.attribute.standard; 40: 41: import java.util.Locale; 42: 43: import javax.print.attribute.Attribute; 44: import javax.print.attribute.DocAttribute; 45: import javax.print.attribute.TextSyntax; 46: 47: /** 48: * The <code>DocumentName</code> printing attribute specifies a document name. 49: * <p> 50: * The document name may be different than the name of the job. It must not be 51: * unique across multiple documents in the same print job. Normally, an 52: * application provides the document name for the user by using e.g. the file 53: * name or a name generated automatically by the application. 54: * </p> 55: * <p> 56: * <b>IPP Compatibility:</b> DocumentName is an IPP 1.1 attribute. 57: * </p> 58: * @see javax.print.attribute.standard.JobName 59: * 60: * @author Michael Koch (konqueror@gmx.de) 61: */ 62: public final class DocumentName extends TextSyntax 63: implements DocAttribute 64: { 65: private static final long serialVersionUID = 7883105848533280430L; 66: 67: /** 68: * Creates a <code>DocumentName</code> object. 69: * 70: * @param documentName the document name 71: * @param locale the locale to use, if <code>null</code> the default 72: * locale is used. 73: * 74: * @exception NullPointerException if documentName is null 75: */ 76: public DocumentName(String documentName, Locale locale) 77: { 78: super(documentName, locale); 79: } 80: 81: /** 82: * Tests if the given object is equal to this object. 83: * 84: * @param obj the object to test 85: * 86: * @return <code>true</code> if both objects are equal, 87: * <code>false</code> otherwise. 88: */ 89: public boolean equals(Object obj) 90: { 91: if(! (obj instanceof DocumentName)) 92: return false; 93: 94: return super.equals(obj); 95: } 96: 97: /** 98: * Returns category of this class. 99: * 100: * @return The class <code>DocumentName</code> itself. 101: */ 102: public Class< ? extends Attribute> getCategory() 103: { 104: return DocumentName.class; 105: } 106: 107: /** 108: * Returns the name of this attribute. 109: * 110: * @return The name "document-name". 111: */ 112: public String getName() 113: { 114: return "document-name"; 115: } 116: }