Imported GNU Classpath 0.20

[pf3gnuchains/gcc-fork.git] / libjava / classpath / javax / print / attribute / standard / JobMediaSheets.java

diff --git a/libjava/classpath/javax/print/attribute/standard/JobMediaSheets.java b/libjava/classpath/javax/print/attribute/standard/JobMediaSheets.java
index 662c54a..75e072c 100644 (file)
--- a/libjava/classpath/javax/print/attribute/standard/JobMediaSheets.java
+++ b/libjava/classpath/javax/print/attribute/standard/JobMediaSheets.java
@@ -1,5 +1,5 @@
 /* JobMediaSheets.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,28 @@ import javax.print.attribute.PrintJobAttribute;
 import javax.print.attribute.PrintRequestAttribute;
 
 /**
+ * The <code>JobMediaSheets</code> printing attribute specifies
+ * the total number of media sheets needed by a job.
+ * <p>
+ * In contrary to the other job size attributes this attribute must include
+ * the multiplication factor from the number of copies if a Copies attribute
+ * was specified for the job.
+ * </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> JobMediaSheets is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobKOctets
+ * @see javax.print.attribute.standard.JobImpressions
+ * 
  * @author Michael Koch
  */
 public class JobMediaSheets extends IntegerSyntax
@@ -54,7 +76,7 @@ public class JobMediaSheets extends IntegerSyntax
    *
    * @param value the number of media sheets for a print job
    *
-   * @exception IllegalArgumentException if value < 0
+   * @exception IllegalArgumentException if value &lt; 0
    */
   public JobMediaSheets(int value)
   {
@@ -65,11 +87,12 @@ public class JobMediaSheets 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 +105,7 @@ public class JobMediaSheets extends IntegerSyntax
   /**
    * Returns category of this class.
    *
-   * @return the class <code>JobMediaSheets</code> itself
+   * @return The class <code>JobMediaSheets</code> itself.
    */
   public Class getCategory()
   {
@@ -90,9 +113,9 @@ public class JobMediaSheets extends IntegerSyntax
   }
 
   /**
-   * Returns name of this class.
+   * Returns the name of this attribute.
    *
-   * @return the string "job-media-sheets"
+   * @return The name "job-media-sheets".
    */
   public String getName()
   {