src/java.desktop/share/classes/javax/print/attribute/standard/DocumentName.java

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -20,101 +20,98 @@
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
+
 package javax.print.attribute.standard;
 
 import java.util.Locale;
 
 import javax.print.attribute.Attribute;
-import javax.print.attribute.TextSyntax;
 import javax.print.attribute.DocAttribute;
+import javax.print.attribute.TextSyntax;
 
 /**
- * Class DocumentName is a printing attribute class, a text attribute, that
- * specifies the name of a document. DocumentName is an attribute of the print
- * data (the doc), not of the Print Job. A document's name is an arbitrary
- * string defined by the client.
- * However if a JobName is not specified, the DocumentName should be used
- * instead, which implies that supporting specification of DocumentName
- * requires reporting of JobName and vice versa.
- * See {@link JobName JobName} for more information.
- * <P>
- * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
+ * Class {@code DocumentName} is a printing attribute class, a text attribute,
+ * that specifies the name of a document. {@code DocumentName} is an attribute
+ * of the print data (the doc), not of the Print Job. A document's name is an
+ * arbitrary string defined by the client. However if a JobName is not
+ * specified, the {@code DocumentName} should be used instead, which implies
+ * that supporting specification of {@code DocumentName} requires reporting of
+ * JobName and vice versa. See {@link JobName JobName} for more information.
+ * <p>
+ * <b>IPP Compatibility:</b> The string value gives the IPP name value. The
  * locale gives the IPP natural language. The category name returned by
  * {@code getName()} gives the IPP attribute name.
  *
  * @author  Alan Kaminsky
  */
 public final class DocumentName extends TextSyntax implements DocAttribute {
 
+    /**
+     * Use serialVersionUID from JDK 1.4 for interoperability.
+     */
     private static final long serialVersionUID = 7883105848533280430L;
 
     /**
-     * Constructs a new document name attribute with the given document name
-     * and locale.
-     *
-     * @param  documentName  Document name.
-     * @param  locale        Natural language of the text string. null
-     * is interpreted to mean the default locale as returned
-     * by {@code Locale.getDefault()}
+     * Constructs a new document name attribute with the given document name and
+     * locale.
      *
-     * @exception  NullPointerException
-     *   (unchecked exception) Thrown if {@code documentName} is null.
+     * @param  documentName document name
+     * @param  locale natural language of the text string. {@code null} is
+     *         interpreted to mean the default locale as returned by
+     *         {@code Locale.getDefault()}
+     * @throws NullPointerException if {@code documentName} is {@code null}
      */
     public DocumentName(String documentName, Locale locale) {
         super (documentName, locale);
     }
 
     /**
-     * Returns whether this document name attribute is equivalent to the
-     * passed in object.
-     * To be equivalent, all of the following conditions must be true:
-     * <OL TYPE=1>
-     * <LI>
-     * {@code object} is not null.
-     * <LI>
-     * {@code object} is an instance of class DocumentName.
-     * <LI>
-     * This document name attribute's underlying string and
+     * Returns whether this document name attribute is equivalent to the passed
+     * in object. To be equivalent, all of the following conditions must be
+     * true:
+     * <ol type=1>
+     *   <li>{@code object} is not {@code null}.
+     *   <li>{@code object} is an instance of class {@code DocumentName}.
+     *   <li>This document name attribute's underlying string and
      * {@code object}'s underlying string are equal.
-     * <LI>
-     * This document name attribute's locale and {@code object}'s locale
+     *   <li>This document name attribute's locale and {@code object}'s locale
      * are equal.
-     * </OL>
+     * </ol>
      *
-     * @param  object  Object to compare to.
-     *
-     * @return  True if {@code object} is equivalent to this document
-     *          name attribute, false otherwise.
+     * @param  object {@code Object} to compare to
+     * @return {@code true} if {@code object} is equivalent to this document
+     *         name attribute, {@code false} otherwise
      */
     public boolean equals(Object object) {
         return (super.equals (object) && object instanceof DocumentName);
     }
 
     /**
      * Get the printing attribute class which is to be used as the "category"
      * for this printing attribute value.
-     * <P>
-     * For class DocumentName, the category is class DocumentName itself.
+     * <p>
+     * For class {@code DocumentName}, the category is class
+     * {@code DocumentName} itself.
      *
-     * @return  Printing attribute class (category), an instance of class
-     *          {@link java.lang.Class java.lang.Class}.
+     * @return printing attribute class (category), an instance of class
+     *         {@link Class java.lang.Class}
      */
     public final Class<? extends Attribute> getCategory() {
         return DocumentName.class;
     }
 
     /**
      * Get the name of the category of which this attribute value is an
      * instance.
-     * <P>
-     * For class DocumentName, the category name is {@code "document-name"}.
+     * <p>
+     * For class {@code DocumentName}, the category name is
+     * {@code "document-name"}.
      *
-     * @return  Attribute category name.
+     * @return attribute category name
      */
     public final String getName() {
         return "document-name";
     }
-
 }