diff options
Diffstat (limited to 'libjava/classpath/javax/print/attribute/standard/JobKOctets.java')
| -rw-r--r-- | libjava/classpath/javax/print/attribute/standard/JobKOctets.java | 40 |
1 files changed, 33 insertions, 7 deletions
diff --git a/libjava/classpath/javax/print/attribute/standard/JobKOctets.java b/libjava/classpath/javax/print/attribute/standard/JobKOctets.java index 71f02c577a7..b380aa17ce9 100644 --- a/libjava/classpath/javax/print/attribute/standard/JobKOctets.java +++ b/libjava/classpath/javax/print/attribute/standard/JobKOctets.java @@ -1,5 +1,5 @@ /* JobKOctets.java -- - Copyright (C) 2003 Free Software Foundation, Inc. + Copyright (C) 2003, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -42,6 +42,30 @@ import javax.print.attribute.PrintJobAttribute; import javax.print.attribute.PrintRequestAttribute; /** + * The <code>JobKOctets</code> printing attribute specifies + * the total size of all the documents of a print job in K octets. + * <p> + * The supplied value has to be rounded up, so that a range between + * 1 and 1024 octects is specified as 1 and a range between 1025 and + * 2048 octects as 2, etc. This attribute must not include a multiplication + * factor from the number of copies which maybe specified in a Copies + * attribute. + * </p> + * <p> + * This attribute belongs to a group of job size attributes which are + * describing the size of a job to be printed. The values supplied by + * these attributes are intended to be used for routing and scheduling + * of jobs on the print service. A client may specify these attributes. + * If a clients supplies these attributes a print service may change + * the values if its be able to compute a more accurate value at the + * time of the job submission or also later. + * </p> + * <p> + * <b>IPP Compatibility:</b> JobKOctets is an IPP 1.1 attribute. + * </p> + * @see javax.print.attribute.standard.JobMediaSheets + * @see javax.print.attribute.standard.JobImpressions + * * @author Michael Koch */ public final class JobKOctets extends IntegerSyntax @@ -51,10 +75,11 @@ public final class JobKOctets extends IntegerSyntax /** * Creates a <code>JobKOctets</code> object. + * The value is in units of K (1024) octets rounded up to the next highest K. * * @param value the number of K octets * - * @exception IllegalArgumentException if value < 0 + * @exception IllegalArgumentException if value < 0 */ public JobKOctets(int value) { @@ -65,11 +90,12 @@ public final class JobKOctets 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) { @@ -82,7 +108,7 @@ public final class JobKOctets extends IntegerSyntax /** * Returns category of this class. * - * @return the class <code>JobKOctets</code> itself + * @return The class <code>JobKOctets</code> itself. */ public Class getCategory() { @@ -90,9 +116,9 @@ public final class JobKOctets extends IntegerSyntax } /** - * Returns name of this class. + * Returns the name of this attribute. * - * @return the string "job-k-octets" + * @return The name "job-k-octets". */ public String getName() { |
