[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: Api doc updates for IntegerSyntax based printing attri
|
From: |
Wolfgang Baer |
|
Subject: |
[cp-patches] FYI: Api doc updates for IntegerSyntax based printing attributes. |
|
Date: |
Fri, 16 Dec 2005 23:05:45 +0100 |
|
User-agent: |
Debian Thunderbird 1.0.7 (X11/20051017) |
Hi all,
only api doc updates except one minor fix to return the correct
name of the attribute class.
Regards,
Wolfgang
2005-12-16 Wolfgang Baer <address@hidden>
* javax/print/attribute/standard/JobImpressionsCompleted.java:
Added and updated javadocs to class and methods.
(getName): Fixed name returned by this attribute class.
* javax/print/attribute/standard/JobMediaSheetsCompleted.java,
* javax/print/attribute/standard/JobKOctetsProcessed.java,
* javax/print/attribute/standard/JobImpressions.java,
* javax/print/attribute/standard/JobKOctets.java,
* javax/print/attribute/standard/JobMediaSheets.java,
* javax/print/attribute/standard/NumberOfInterveningJobs.java,
* javax/print/attribute/standard/JobPriority.java,
* javax/print/attribute/standard/JobPrioritySupported.java,
* javax/print/attribute/standard/NumberOfDocuments.java,
* javax/print/attribute/standard/QueuedJobCount.java,
* javax/print/attribute/standard/NumberUp.java,
* javax/print/attribute/standard/PagesPerMinuteColor.java,
* javax/print/attribute/standard/PagesPerMinute.java,
* javax/print/attribute/standard/Copies.java:
Added and updated javadocs to class and methods.
Index: javax/print/attribute/standard/JobImpressionsCompleted.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobImpressionsCompleted.java,v
retrieving revision 1.5
diff -u -r1.5 JobImpressionsCompleted.java
--- javax/print/attribute/standard/JobImpressionsCompleted.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/JobImpressionsCompleted.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* JobImpressionsCompleted.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.PrintJobAttribute;
/**
+ * The <code>JobImpressionsCompleted</code> printing attribute reports
+ * the number of impressions already processed.
+ * <p>
+ * An impression is specified by the IPP specification as the image imposed
+ * onto a single media sheet. 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> JobImpressionsCompleted is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobMediaSheetsCompleted
+ * @see javax.print.attribute.standard.JobKOctetsProcessed
+ *
* @author Michael Koch (address@hidden)
*/
public final class JobImpressionsCompleted extends IntegerSyntax
@@ -53,7 +70,7 @@
*
* @param value the number of completed impressions
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public JobImpressionsCompleted(int value)
{
@@ -64,11 +81,12 @@
}
/**
- * 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 +99,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobImpressionsCompleted</code> itself
+ * @return The class <code>JobImpressionsCompleted</code> itself.
*/
public Class getCategory()
{
@@ -89,12 +107,12 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-impressions-completed"
+ * @return The name "job-impressions-completed".
*/
public String getName()
{
- return "job-impressions";
+ return "job-impressions-completed";
}
}
Index: javax/print/attribute/standard/JobMediaSheetsCompleted.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobMediaSheetsCompleted.java,v
retrieving revision 1.5
diff -u -r1.5 JobMediaSheetsCompleted.java
--- javax/print/attribute/standard/JobMediaSheetsCompleted.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/JobMediaSheetsCompleted.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* JobMediaSheetsCompleted.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,18 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>JobMediaSheetsCompleted</code> printing attribute reports
+ * the number of media sheets already processed.
+ * <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> JobMediaSheetsCompleted is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobImpressionsCompleted
+ * @see javax.print.attribute.standard.JobKOctetsProcessed
+ *
* @author Michael Koch
*/
public final class JobMediaSheetsCompleted extends IntegerSyntax
@@ -51,9 +63,9 @@
/**
* Creates a <code>JobMediaSheetsCompleted</code> object.
*
- * @param value the number of completed media sheets for a print job
+ * @param value the number of completed media sheets
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public JobMediaSheetsCompleted(int value)
{
@@ -64,11 +76,12 @@
}
/**
- * 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 +94,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobMediaSheetsCompleted</code> itself
+ * @return The class <code>JobMediaSheetsCompleted</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +102,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-media-sheets-completed"
+ * @return The name "job-media-sheets-completed".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobKOctetsProcessed.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobKOctetsProcessed.java,v
retrieving revision 1.5
diff -u -r1.5 JobKOctetsProcessed.java
--- javax/print/attribute/standard/JobKOctetsProcessed.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/JobKOctetsProcessed.java 16 Dec 2005
22:01:03 -0000
@@ -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.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 @@
/**
* 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 @@
}
/**
- * 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 @@
/**
* 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 @@
}
/**
- * 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()
{
Index: javax/print/attribute/standard/JobImpressions.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobImpressions.java,v
retrieving revision 1.4
diff -u -r1.4 JobImpressions.java
--- javax/print/attribute/standard/JobImpressions.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/JobImpressions.java 16 Dec 2005 22:01:03
-0000
@@ -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.
@@ -42,6 +42,31 @@
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
@@ -54,7 +79,7 @@
*
* @param value the number of impressions
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public JobImpressions(int value)
{
@@ -65,11 +90,12 @@
}
/**
- * 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 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobImpressions</code> itself
+ * @return The class <code>JobImpressions</code> itself.
*/
public Class getCategory()
{
@@ -90,9 +116,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-impressions"
+ * @return The name "job-impressions".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobKOctets.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobKOctets.java,v
retrieving revision 1.4
diff -u -r1.4 JobKOctets.java
--- javax/print/attribute/standard/JobKOctets.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/JobKOctets.java 16 Dec 2005 22:01:03
-0000
@@ -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.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 @@
/**
* 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 @@
}
/**
- * 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 @@
/**
* 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 @@
}
/**
- * 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()
{
Index: javax/print/attribute/standard/JobMediaSheets.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobMediaSheets.java,v
retrieving revision 1.4
diff -u -r1.4 JobMediaSheets.java
--- javax/print/attribute/standard/JobMediaSheets.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/JobMediaSheets.java 16 Dec 2005 22:01:03
-0000
@@ -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.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 @@
*
* @param value the number of media sheets for a print job
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public JobMediaSheets(int value)
{
@@ -65,11 +87,12 @@
}
/**
- * 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 @@
/**
* 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 @@
}
/**
- * 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()
{
Index: javax/print/attribute/standard/NumberOfInterveningJobs.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/NumberOfInterveningJobs.java,v
retrieving revision 1.5
diff -u -r1.5 NumberOfInterveningJobs.java
--- javax/print/attribute/standard/NumberOfInterveningJobs.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/NumberOfInterveningJobs.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* NumberOfInterveningJobs.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,13 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>NumberOfInterveningJobs</code> printing attribute provides
+ * the number of jobs ahead in the print service queue before the
+ * requested job.
+ * <p>
+ * <b>IPP Compatibility:</b> NumberOfInterveningJobs is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch
*/
public final class NumberOfInterveningJobs extends IntegerSyntax
@@ -53,7 +60,7 @@
*
* @param value the number of intervening jobs
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public NumberOfInterveningJobs(int value)
{
@@ -64,11 +71,12 @@
}
/**
- * 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 +89,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>NumberOfInterveningJobs</code> itself
+ * @return The class <code>NumberOfInterveningJobs</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +97,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "number-of-intervening-jobs"
+ * @return The name "number-of-intervening-jobs".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobPriority.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobPriority.java,v
retrieving revision 1.5
diff -u -r1.5 JobPriority.java
--- javax/print/attribute/standard/JobPriority.java 2 Jul 2005 20:32:46
-0000 1.5
+++ javax/print/attribute/standard/JobPriority.java 16 Dec 2005 22:01:03
-0000
@@ -1,5 +1,5 @@
/* JobPriority.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.
@@ -43,6 +43,17 @@
/**
+ * The <code>JobPriority</code> printing attribute specifies
+ * the priority for scheduling a job on the print service.
+ * <p>
+ * A client may specify any value between 1 (lowest priority) and 100
+ * (highest priority). A print service prints jobs with a priority
+ * value of n before those with a priority value of n-1.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> JobPriority is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
*/
public final class JobPriority extends IntegerSyntax
@@ -55,7 +66,7 @@
*
* @param value the priority
*
- * @exception IllegalArgumentException if value < 1 or value > 100
+ * @exception IllegalArgumentException if value < 1 or value > 100
*/
public JobPriority(int value)
{
@@ -66,11 +77,12 @@
}
/**
- * 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 +95,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobPriority</code> itself
+ * @return The class <code>JobPriority</code> itself.
*/
public Class getCategory()
{
@@ -91,9 +103,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-priority"
+ * @return The name "job-priority".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobPrioritySupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobPrioritySupported.java,v
retrieving revision 1.5
diff -u -r1.5 JobPrioritySupported.java
--- javax/print/attribute/standard/JobPrioritySupported.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/JobPrioritySupported.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* JobPrioritySupported.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.
@@ -42,6 +42,20 @@
/**
+ * The <code>JobPrioritySupported</code> printing attribute provides
+ * the supported values for the <code>JobPriority</code> attribute.
+ * <p>
+ * A client may specify any JobPriority value between 1 and 100. If a
+ * print service supports fewer priority levels it indicates the maximum
+ * levels through this attribute. The print service then automatically
+ * maps the job priority value provided by the client in an even distribution
+ * over the whole range of 1 to 100.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> JobPrioritySupported is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobPriority
+ *
* @author Michael Koch (address@hidden)
*/
public final class JobPrioritySupported extends IntegerSyntax
@@ -54,7 +68,7 @@
*
* @param value the priority
*
- * @exception IllegalArgumentException if value < 1 or value > 100
+ * @exception IllegalArgumentException if value < 1 or value > 100
*/
public JobPrioritySupported(int value)
{
@@ -65,11 +79,12 @@
}
/**
- * 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 +97,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobPrioritySupported</code> itself
+ * @return The class <code>JobPrioritySupported</code> itself.
*/
public Class getCategory()
{
@@ -90,9 +105,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-priority-supported"
+ * @return The name "job-priority-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/NumberOfDocuments.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/NumberOfDocuments.java,v
retrieving revision 1.4
diff -u -r1.4 NumberOfDocuments.java
--- javax/print/attribute/standard/NumberOfDocuments.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/NumberOfDocuments.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* NumberOfDocuments.java --
- Copyright (C) 2003 Free Software Foundation, Inc.
+ Copyright (C) 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -41,6 +41,12 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>NumberOfDocuments</code> printing attribute specifies
+ * the number of documents in a job.
+ * <p>
+ * <b>IPP Compatibility:</b> NumberOfDocuments is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch
*/
public final class NumberOfDocuments extends IntegerSyntax
@@ -53,7 +59,7 @@
*
* @param value the number of documents
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public NumberOfDocuments(int value)
{
@@ -64,11 +70,12 @@
}
/**
- * 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 +88,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>NumberOfDocuments</code> itself
+ * @return The class <code>NumberOfDocuments</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +96,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "number-of-documents"
+ * @return The name "number-of-documents".
*/
public String getName()
{
Index: javax/print/attribute/standard/QueuedJobCount.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/QueuedJobCount.java,v
retrieving revision 1.3
diff -u -r1.3 QueuedJobCount.java
--- javax/print/attribute/standard/QueuedJobCount.java 2 Jul 2005 20:32:46
-0000 1.3
+++ javax/print/attribute/standard/QueuedJobCount.java 16 Dec 2005 22:01:03
-0000
@@ -1,5 +1,5 @@
/* QueuedJobCount.java --
- Copyright (C) 2003 Free Software Foundation, Inc.
+ Copyright (C) 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -41,6 +41,15 @@
import javax.print.attribute.PrintServiceAttribute;
/**
+ * The <code>QueuedJobCount</code> printing attribute reports
+ * the number of jobs currently in the queue. These are jobs
+ * that are in 'pending', 'processing', 'pending-held' or
+ * 'processing-stopped' state.
+ * <p>
+ * <b>IPP Compatibility:</b> QueuedJobCount is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.JobState
+ *
* @author Michael Koch
*/
public final class QueuedJobCount extends IntegerSyntax
@@ -53,7 +62,7 @@
*
* @param value the number of queued jobs
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public QueuedJobCount(int value)
{
@@ -64,11 +73,12 @@
}
/**
- * 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 +91,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>QueuedJobCount</code> itself
+ * @return The class <code>QueuedJobCount</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +99,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "queued-job-count"
+ * @return The name "queued-job-count".
*/
public String getName()
{
Index: javax/print/attribute/standard/NumberUp.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/NumberUp.java,v
retrieving revision 1.4
diff -u -r1.4 NumberUp.java
--- javax/print/attribute/standard/NumberUp.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/NumberUp.java 16 Dec 2005 22:01:03
-0000
@@ -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.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
+ * address@hidden 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 @@
* @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 < 1
*/
public NumberUp(int value)
{
@@ -64,11 +75,12 @@
}
/**
- * 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 @@
/**
* 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 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "number-up"
+ * @return The name "number-up".
*/
public String getName()
{
Index: javax/print/attribute/standard/PagesPerMinuteColor.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PagesPerMinuteColor.java,v
retrieving revision 1.4
diff -u -r1.4 PagesPerMinuteColor.java
--- javax/print/attribute/standard/PagesPerMinuteColor.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/PagesPerMinuteColor.java 16 Dec 2005
22:01:03 -0000
@@ -1,5 +1,5 @@
/* PagesPerMinuteColor.java --
- Copyright (C) 2003 Free Software Foundation, Inc.
+ Copyright (C) 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -41,6 +41,13 @@
import javax.print.attribute.PrintServiceAttribute;
/**
+ * The <code>PagesPerMinuteColor</code> printing attribute specifies
+ * the nominal number of pages per minute which may be printed in
+ * color by the printer.
+ * <p>
+ * <b>IPP Compatibility:</b> PagesPerMinuteColor is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch
*/
public final class PagesPerMinuteColor extends IntegerSyntax
@@ -51,9 +58,9 @@
/**
* Creates a <code>PagesPerMinuteColor</code> object.
*
- * @param value the number of pages per minute
+ * @param value the number of pages per minute in color
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public PagesPerMinuteColor(int value)
{
@@ -64,11 +71,12 @@
}
/**
- * 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 +89,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>PagesPerMinuteColor</code> itself
+ * @return The class <code>PagesPerMinuteColor</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +97,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "pages-per-minute-color"
+ * @return The name "pages-per-minute-color".
*/
public String getName()
{
Index: javax/print/attribute/standard/PagesPerMinute.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PagesPerMinute.java,v
retrieving revision 1.4
diff -u -r1.4 PagesPerMinute.java
--- javax/print/attribute/standard/PagesPerMinute.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/PagesPerMinute.java 16 Dec 2005 22:01:03
-0000
@@ -1,5 +1,5 @@
/* PagesPerMinute.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.
@@ -42,6 +42,13 @@
import javax.print.attribute.PrintServiceAttribute;
/**
+ * The <code>PagesPerMinute</code> printing attribute specifies
+ * the nominal number of pages per minute which may be printed
+ * by the printer.
+ * <p>
+ * <b>IPP Compatibility:</b> PagesPerMinute is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
*/
public final class PagesPerMinute extends IntegerSyntax
@@ -54,7 +61,7 @@
*
* @param value the number of pages per minute
*
- * @exception IllegalArgumentException if value < 0
+ * @exception IllegalArgumentException if value < 0
*/
public PagesPerMinute(int value)
{
@@ -65,11 +72,12 @@
}
/**
- * 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 +90,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>PagesPerMinute</code> itself
+ * @return The class <code>PagesPerMinute</code> itself.
*/
public Class getCategory()
{
@@ -90,9 +98,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "pages-per-minute"
+ * @return The name "pages-per-minute".
*/
public String getName()
{
Index: javax/print/attribute/standard/Copies.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/Copies.java,v
retrieving revision 1.4
diff -u -r1.4 Copies.java
--- javax/print/attribute/standard/Copies.java 2 Jul 2005 20:32:46 -0000
1.4
+++ javax/print/attribute/standard/Copies.java 16 Dec 2005 22:01:03 -0000
@@ -1,5 +1,5 @@
/* Copies.java --
- Copyright (C) 2003 Free Software Foundation, Inc.
+ Copyright (C) 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -33,7 +33,7 @@
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
-exception statement from your version. */
+exception statement from your version. */
package javax.print.attribute.standard;
@@ -42,7 +42,19 @@
import javax.print.attribute.PrintRequestAttribute;
/**
- * @author Michael Koch
+ * The <code>Copies</code> printing attribute specifies the number
+ * of copies to be printed.
+ * <p>
+ * <b>Note:</b> The effect of this attribute on jobs with multiple documents
+ * is controlled by the job attribute
+ * address@hidden javax.print.attribute.standard.MultipleDocumentHandling}.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> Copies is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.MultipleDocumentHandling
+ *
+ * @author Michael Koch (address@hidden)
*/
public final class Copies extends IntegerSyntax
implements PrintJobAttribute, PrintRequestAttribute
@@ -54,7 +66,7 @@
*
* @param value the number of copies
*
- * @exception IllegalArgumentException if value < 1
+ * @exception IllegalArgumentException if value < 1
*/
public Copies(int value)
{
@@ -65,11 +77,12 @@
}
/**
- * 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 +95,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>Copies</code> itself
+ * @return The class <code>Copies</code> itself.
*/
public Class getCategory()
{
@@ -90,9 +103,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "copies"
+ * @return The name "copies".
*/
public String getName()
{
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: Api doc updates for IntegerSyntax based printing attributes.,
Wolfgang Baer <=