summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java
diff options
context:
space:
mode:
authorMark Wielaard <mark@gcc.gnu.org>2006-01-17 18:09:40 +0000
committerMark Wielaard <mark@gcc.gnu.org>2006-01-17 18:09:40 +0000
commit2127637945ea6b763966398130e0770fa993c860 (patch)
treec976ca91e3ef0bda3b34b37c0195145638d8d08e /libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java
parentbcb36c3e02e3bd2843aad1b9888513dfb5d6e337 (diff)
downloadgcc-2127637945ea6b763966398130e0770fa993c860.tar.gz
Imported GNU Classpath 0.20
Imported GNU Classpath 0.20 * Makefile.am (AM_CPPFLAGS): Add classpath/include. * java/nio/charset/spi/CharsetProvider.java: New override file. * java/security/Security.java: Likewise. * sources.am: Regenerated. * Makefile.in: Likewise. From-SVN: r109831
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java')
-rw-r--r--libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java26
1 files changed, 19 insertions, 7 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java b/libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java
index 84eab8b6219..8eaae357c88 100644
--- a/libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java
+++ b/libjava/classpath/javax/print/attribute/standard/JobMessageFromOperator.java
@@ -1,5 +1,5 @@
/* JobMessageFromOperator.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,15 @@ import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.TextSyntax;
/**
+ * The <code>JobMessageFromOperator</code> printing attribute provides
+ * a message from an operator or a system administrator related to the
+ * print job. This may include information why a certain action has been
+ * taken on the print job like a modification.
+ * <p>
+ * <b>IPP Compatibility:</b> JobMessageFromOperator is an IPP 1.1
+ * attribute.
+ * </p>
+ *
* @author Michael Koch (konqueror@gmx.de)
*/
public final class JobMessageFromOperator extends TextSyntax
@@ -55,8 +64,10 @@ public final class JobMessageFromOperator extends TextSyntax
* Creates a <code>JobMessageFromOperator</code> object.
*
* @param message the message
+ * @param locale the locale to use, if <code>null</code> the default
+ * locale is used.
*
- * @exception NullPointerException if message is null
+ * @exception NullPointerException if message is <code>null</code>.
*/
public JobMessageFromOperator(String message, Locale locale)
{
@@ -64,11 +75,12 @@ public final class JobMessageFromOperator 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 +93,7 @@ public final class JobMessageFromOperator extends TextSyntax
/**
* Returns category of this class.
*
- * @return the class <code>JobMessageFromOperator</code> itself
+ * @return The class <code>JobMessageFromOperator</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +101,9 @@ public final class JobMessageFromOperator extends TextSyntax
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-message-from-operator"
+ * @return The name "job-message-from-operator".
*/
public String getName()
{