summaryrefslogtreecommitdiff
path: root/javax/print/attribute/standard/JobImpressions.java
diff options
context:
space:
mode:
Diffstat (limited to 'javax/print/attribute/standard/JobImpressions.java')
-rw-r--r--javax/print/attribute/standard/JobImpressions.java40
1 files changed, 33 insertions, 7 deletions
diff --git a/javax/print/attribute/standard/JobImpressions.java b/javax/print/attribute/standard/JobImpressions.java
index ba0682585..a2c7d4dd6 100644
--- a/javax/print/attribute/standard/JobImpressions.java
+++ b/javax/print/attribute/standard/JobImpressions.java
@@ -1,5 +1,5 @@
/* JobImpressions.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,31 @@ import javax.print.attribute.PrintJobAttribute;
import javax.print.attribute.PrintRequestAttribute;
/**
+ * The <code>JobImpressions</code> printing attribute specifies
+ * the total size in number of impressions of the documents
+ * of a a print job.
+ * <p>
+ * An impression is specified by the IPP specification as the image
+ * (possibly many print-stream pages in different configurations)
+ * imposed onto a single media sheet. 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> JobImpressions is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobKOctets
+ * @see javax.print.attribute.standard.JobMediaSheets
+ *
* @author Michael Koch
*/
public final class JobImpressions extends IntegerSyntax
@@ -55,7 +80,7 @@ public final class JobImpressions extends IntegerSyntax
*
* @param value the number of impressions
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value &lt; 0
*/
public JobImpressions(int value)
{
@@ -66,11 +91,12 @@ public final class JobImpressions 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)
{
@@ -83,7 +109,7 @@ public final class JobImpressions extends IntegerSyntax
/**
* Returns category of this class.
*
- * @return the class <code>JobImpressions</code> itself
+ * @return The class <code>JobImpressions</code> itself.
*/
public Class< ? extends Attribute> getCategory()
{
@@ -91,9 +117,9 @@ public final class JobImpressions extends IntegerSyntax
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-impressions"
+ * @return The name "job-impressions".
*/
public String getName()
{