summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java')
-rw-r--r--libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java23
1 files changed, 16 insertions, 7 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java b/libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java
index 116de28cfb7..2d6e79df654 100644
--- a/libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java
+++ b/libjava/classpath/javax/print/attribute/standard/JobOriginatingUserName.java
@@ -1,5 +1,5 @@
/* JobOriginatingUserName.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,12 @@ import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.TextSyntax;
/**
+ * The <code>JobOriginatingUserName</code> attribute specifies the name of
+ * the user which submitted the print job.
+ * <p>
+ * <b>IPP Compatibility:</b> JobOriginatingUserName is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (konqueror@gmx.de)
*/
public final class JobOriginatingUserName extends TextSyntax
@@ -55,8 +61,10 @@ public final class JobOriginatingUserName extends TextSyntax
* Creates a <code>JobOriginatingUserName</code> object.
*
* @param userName the user name
+ * @param locale the locale to use, if <code>null</code> the default
+ * locale is used.
*
- * @exception NullPointerException if userName is null
+ * @exception NullPointerException if userName is <code>null</code>.
*/
public JobOriginatingUserName(String userName, Locale locale)
{
@@ -64,11 +72,12 @@ public final class JobOriginatingUserName 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 +90,7 @@ public final class JobOriginatingUserName extends TextSyntax
/**
* Returns category of this class.
*
- * @return the class <code>JobOriginatingUserName</code> itself
+ * @return The class <code>JobOriginatingUserName</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +98,9 @@ public final class JobOriginatingUserName extends TextSyntax
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-originating-user-name"
+ * @return The name "job-originating-user-name".
*/
public String getName()
{