001/* DocumentName.java -- 
002   Copyright (C) 2004, 2005 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
038
039package javax.print.attribute.standard;
040
041import java.util.Locale;
042
043import javax.print.attribute.Attribute;
044import javax.print.attribute.DocAttribute;
045import javax.print.attribute.TextSyntax;
046
047/**
048 * The <code>DocumentName</code> printing attribute specifies a document name.
049 * <p>
050 * The document name may be different than the name of the job. It must not be
051 * unique across multiple documents in the same print job. Normally, an 
052 * application provides the document name for the user by using e.g. the file 
053 * name or a name generated automatically by the application.
054 * </p>
055 * <p>
056 * <b>IPP Compatibility:</b> DocumentName is an IPP 1.1 attribute.
057 * </p>
058 * @see javax.print.attribute.standard.JobName
059 * 
060 * @author Michael Koch (konqueror@gmx.de)
061 */
062public final class DocumentName extends TextSyntax
063  implements DocAttribute
064{
065  private static final long serialVersionUID = 7883105848533280430L;
066
067  /**
068   * Creates a <code>DocumentName</code> object.
069   *
070   * @param documentName the document name
071   * @param locale the locale to use, if <code>null</code> the default
072   * locale is used.
073   *
074   * @exception NullPointerException if documentName is null
075   */
076  public DocumentName(String documentName, Locale locale)
077  {
078    super(documentName, locale);
079  }
080
081  /**
082   * Tests if the given object is equal to this object.
083   *
084   * @param obj the object to test
085   *
086   * @return <code>true</code> if both objects are equal, 
087   * <code>false</code> otherwise.
088   */
089  public boolean equals(Object obj)
090  {
091    if(! (obj instanceof DocumentName))
092      return false;
093
094    return super.equals(obj);
095  }
096
097  /**
098   * Returns category of this class.
099   *
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}