diff options
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/DocumentName.java')
| -rw-r--r-- | libjava/classpath/javax/print/attribute/standard/DocumentName.java | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/DocumentName.java b/libjava/classpath/javax/print/attribute/standard/DocumentName.java index 2c472aa2012..d1428ed8b79 100644 --- a/libjava/classpath/javax/print/attribute/standard/DocumentName.java +++ b/libjava/classpath/javax/print/attribute/standard/DocumentName.java @@ -1,5 +1,5 @@ /* DocumentName.java -- - Copyright (C) 2004 Free Software Foundation, Inc. + Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -44,6 +44,18 @@ import javax.print.attribute.DocAttribute; import javax.print.attribute.TextSyntax; /** + * The <code>DocumentName</code> printing attribute specifies a document name. + * <p> + * The document name may be different than the name of the job. It must not be + * unique across multiple documents in the same print job. Normally, an + * application provides the document name for the user by using e.g. the file + * name or a name generated automatically by the application. + * </p> + * <p> + * <b>IPP Compatibility:</b> DocumentName is an IPP 1.1 attribute. + * </p> + * @see javax.print.attribute.standard.JobName + * * @author Michael Koch (konqueror@gmx.de) */ public final class DocumentName extends TextSyntax @@ -55,6 +67,8 @@ public final class DocumentName extends TextSyntax * Creates a <code>DocumentName</code> object. * * @param documentName the document name + * @param locale the locale to use, if <code>null</code> the default + * locale is used. * * @exception NullPointerException if documentName is null */ @@ -64,11 +78,12 @@ public final class DocumentName extends TextSyntax } /** - * Tests of obj is equal to this object. + * Tests if the given object is equal to this object. * * @param obj the object to test * - * @return true if both objects are equal, false otherwise. + * @return <code>true</code> if both objects are equal, + * <code>false</code> otherwise. */ public boolean equals(Object obj) { @@ -81,7 +96,7 @@ public final class DocumentName extends TextSyntax /** * Returns category of this class. * - * @return the class <code>DocumentName</code> itself + * @return The class <code>DocumentName</code> itself. */ public Class getCategory() { @@ -89,9 +104,9 @@ public final class DocumentName extends TextSyntax } /** - * Returns name of this class. + * Returns the name of this attribute. * - * @return the string "document-name" + * @return The name "document-name". */ public String getName() { |
