diff options
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java')
| -rw-r--r-- | libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java b/libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java index 7561222ca6a..762369565e2 100644 --- a/libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java +++ b/libjava/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java @@ -1,5 +1,5 @@ /* JobKOctetsProcessed.java -- - Copyright (C) 2003, 2004 Free Software Foundation, Inc. + Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -41,6 +41,23 @@ import javax.print.attribute.IntegerSyntax; import javax.print.attribute.PrintJobAttribute; /** + * The <code>JobKOctetsProcessed</code> printing attribute reports + * the total number of octets already processed in K octets units. + * <p> + * The supplied value will be rounded up to the next highest K octets. + * This attribute will not include a multiplication factor from the number + * of copies. + * </p> + * <p> + * This attribute belongs to a group of job progress attributes which are + * reporting on the progress of a print job. + * </p> + * <p> + * <b>IPP Compatibility:</b> JobKOctetsProcessed is an IPP 1.1 attribute. + * </p> + * @see javax.print.attribute.standard.JobMediaSheetsCompleted + * @see javax.print.attribute.standard.JobImpressionsCompleted + * * @author Michael Koch */ public final class JobKOctetsProcessed extends IntegerSyntax @@ -50,10 +67,11 @@ public final class JobKOctetsProcessed extends IntegerSyntax /** * Creates a <code>JobKOctetsProcessed</code> object. + * The value is in units of K (1024) octets rounded up to the next highest K. * * @param value the number of processed K octets * - * @exception IllegalArgumentException if value < 0 + * @exception IllegalArgumentException if value < 0 */ public JobKOctetsProcessed(int value) { @@ -64,11 +82,12 @@ public final class JobKOctetsProcessed 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 +100,7 @@ public final class JobKOctetsProcessed extends IntegerSyntax /** * Returns category of this class. * - * @return the class <code>JobKOctetsProcessed</code> itself + * @return The class <code>JobKOctetsProcessed</code> itself. */ public Class getCategory() { @@ -89,9 +108,9 @@ public final class JobKOctetsProcessed extends IntegerSyntax } /** - * Returns name of this class. + * Returns the name of this attribute. * - * @return the string "job-k-octets-processed" + * @return The name "job-k-octets-processed". */ public String getName() { |
