summaryrefslogtreecommitdiffstats
path: root/libjava/classpath/javax/print/attribute/standard/NumberUp.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/NumberUp.java')
-rw-r--r--libjava/classpath/javax/print/attribute/standard/NumberUp.java26
1 files changed, 19 insertions, 7 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/NumberUp.java b/libjava/classpath/javax/print/attribute/standard/NumberUp.java
index 4dee55394c4..aa2324040af 100644
--- a/libjava/classpath/javax/print/attribute/standard/NumberUp.java
+++ b/libjava/classpath/javax/print/attribute/standard/NumberUp.java
@@ -1,5 +1,5 @@
/* NumberUp.java --
- Copyright (C) 2003 Free Software Foundation, Inc.
+ Copyright (C) 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -43,6 +43,17 @@ import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.PrintRequestAttribute;
/**
+ * The <code>NumberUp</code> printing attribute specifies the number of pages
+ * to be arranged upon a single media sheet.
+ * <p>
+ * <b>Note:</b> The effect of this attribute on jobs with multiple documents
+ * is controlled by the job attribute
+ * {@link javax.print.attribute.standard.MultipleDocumentHandling}.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> NumberUp is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch
*/
public final class NumberUp extends IntegerSyntax
@@ -56,7 +67,7 @@ public final class NumberUp extends IntegerSyntax
* @param value the number of print-stream pages to print on a single side
* of a media
*
- * @exception IllegalArgumentException if value < 1
+ * @exception IllegalArgumentException if value &lt; 1
*/
public NumberUp(int value)
{
@@ -64,11 +75,12 @@ public final class NumberUp extends IntegerSyntax
}
/**
- * 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 NumberUp extends IntegerSyntax
/**
* Returns category of this class.
*
- * @return the class <code>NumberUp</code> itself
+ * @return The class <code>NumberUp</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +101,9 @@ public final class NumberUp extends IntegerSyntax
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "number-up"
+ * @return The name "number-up".
*/
public String getName()
{
OpenPOWER on IntegriCloud