[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: Further updates for javax.print.attribute.standard
|
From: |
Wolfgang Baer |
|
Subject: |
[cp-patches] FYI: Further updates for javax.print.attribute.standard |
|
Date: |
Sat, 17 Dec 2005 21:29:06 +0100 |
|
User-agent: |
Debian Thunderbird 1.0.7 (X11/20051017) |
Hi all,
this patch completes the URISyntax, ResolutionSyntax, DateTimeSyntax
and SetOfIntegerSyntax derived printing attribute classes.
Mostly api docs updates, some overridden equals methods and one constructor
update.
Regards,
Wolfgang
2005-12-17 Wolfgang Baer <address@hidden>
* javax/print/attribute/standard/CopiesSupported.java:
Added and updated javadocs to class and methods.
(CopiesSupported): Throw IllegalArgumentException if
lowerBound is less than 1.
(CopiesSupported): Throw IllegalArgumentException
if member less than 1.
(equals): New overridden method.
* javax/print/attribute/standard/JobKOctetsSupported.java:
Added and updated javadocs to class and methods.
(JobKOctetsSupported): Throw IllegalArgumentException if
lowerBound is less than 1.
(equals): New overridden method.
* javax/print/attribute/standard/JobImpressionsSupported.java:
Added and updated javadocs to class and methods.
(JobImpressionsSupported): Throw IllegalArgumentException if
lowerBound is less than 1.
(equals): New overridden method.
* javax/print/attribute/standard/JobMediaSheetsSupported.java:
Added and updated javadocs to class and methods.
(JobMediaSheetsSupported): Throw IllegalArgumentException if
lowerBound is less than 1.
(equals): New overridden method.
* javax/print/attribute/standard/PageRanges.java:
Added and updated javadocs to class and methods.
(PageRanges): Throw IllegalArgumentException if member less than 1.
(PageRanges): Throw IAE if lowerBound is less than 1.
(PageRanges): Throw NPE if members is null.
(PageRanges): New constructor.
(equals): New overridden method.
* javax/print/attribute/standard/NumberUpSupported.java:
Added and updated javadocs to class and methods.
(NumberUpSupported): Throw IllegalArgumentException if
member less than 1.
(NumberUpSupported): Throw IAE if lowerbound less than 1.
(NumberUpSupported): Throw NPE if members is null.
(equals): New overridden method.
* javax/print/attribute/standard/JobHoldUntil.java,
* javax/print/attribute/standard/DateTimeAtProcessing.java,
* javax/print/attribute/standard/DateTimeAtCompleted.java,
* javax/print/attribute/standard/DateTimeAtCreation.java:
Added and updated javadocs to class and methods.
* javax/print/attribute/standard/PrinterURI.java,
* javax/print/attribute/standard/PrinterMoreInfoManufacturer.java,
* javax/print/attribute/standard/PrinterMoreInfo.java,
* javax/print/attribute/standard/Destination.java,
* javax/print/attribute/standard/PrinterResolution.java:
Added and updated javadocs to class and methods.
(equals): New overridden method.
Index: javax/print/attribute/standard/CopiesSupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/CopiesSupported.java,v
retrieving revision 1.4
diff -u -r1.4 CopiesSupported.java
--- javax/print/attribute/standard/CopiesSupported.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/CopiesSupported.java 17 Dec 2005 20:23:57
-0000
@@ -1,5 +1,5 @@
/* CopiesSupported.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -42,7 +42,15 @@
/**
+ * The <code>CopiesSupported</code> attribute specifies the supported
+ * value or range of values for the
+ * address@hidden javax.print.attribute.standard.Copies} attribute.
+ * <p>
+ * <b>IPP Compatibility:</b> CopiesSupported is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class CopiesSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute
@@ -50,25 +58,59 @@
private static final long serialVersionUID = 6927711687034846001L;
/**
- * Constructs a <code>CopiesSupported</code> object.
+ * Constructs a <code>CopiesSupported</code> object with
+ * the given value. This means that only this value is
+ * supported for copies.
+ *
+ * @param member the member value
+ * @exception IllegalArgumentException if member is < 1
*/
public CopiesSupported(int member)
{
super(member);
+
+ if (member < 1)
+ throw new IllegalArgumentException("member may not be less than 1");
}
/**
- * Constructs a <code>CopiesSupported</code> object.
+ * Constructs a <code>CopiesSupported</code> object with
+ * the given range of values. This means that values for
+ * copies are supported inside the specified range.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound < 1
*/
public CopiesSupported(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerBound may not be less than 1");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof CopiesSupported))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>CopiesSupported</code> itself
+ * @return The class <code>CopiesSupported</code> itself.
*/
public Class getCategory()
{
@@ -78,7 +120,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "copies-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobKOctetsSupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobKOctetsSupported.java,v
retrieving revision 1.4
diff -u -r1.4 JobKOctetsSupported.java
--- javax/print/attribute/standard/JobKOctetsSupported.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/JobKOctetsSupported.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* JobKOctetsSupported.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -42,7 +42,15 @@
/**
+ * The <code>JobKOctetsSupported</code> printing attribute specifies the
+ * supported range of values for the
+ * address@hidden javax.print.attribute.standard.JobKOctets} attribute.
+ * <p>
+ * <b>IPP Compatibility:</b> JobKOctetsSupported is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class JobKOctetsSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute
@@ -50,17 +58,43 @@
private static final long serialVersionUID = -2867871140549897443L;
/**
- * Constructs a <code>JobKOctetsSupported</code> object.
+ * Constructs a <code>JobKOctetsSupported</code> object with the
+ * given range for supported K octets.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound <= upperbound
+ * and lowerBound < 1
*/
public JobKOctetsSupported(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerBound may not be less than 1");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if (! (obj instanceof JobKOctetsSupported))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>ColorSupported</code> itself
+ * @return The class <code>JobKOctetsSupported</code> itself.
*/
public Class getCategory()
{
@@ -70,7 +104,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "job-k-octets-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobImpressionsSupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobImpressionsSupported.java,v
retrieving revision 1.4
diff -u -r1.4 JobImpressionsSupported.java
--- javax/print/attribute/standard/JobImpressionsSupported.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/JobImpressionsSupported.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* JobImpressionsSupported.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -42,7 +42,15 @@
/**
+ * The <code>JobImpressionsSupported</code> printing attribute specifies the
+ * supported range of values for the
+ * address@hidden javax.print.attribute.standard.JobImpressions} attribute.
+ * <p>
+ * <b>IPP Compatibility:</b> JobImpressionsSupported is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class JobImpressionsSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute
@@ -50,17 +58,43 @@
private static final long serialVersionUID = -4887354803843173692L;
/**
- * Constructs a <code>JobImpressionsSupported</code> object.
+ * Constructs a <code>JobImpressionsSupported</code> object with the
+ * given range of supported job impressions values.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound <= upperbound
+ * and lowerBound < 1
*/
public JobImpressionsSupported(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerBound may not be less than 1");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if (! (obj instanceof JobImpressionsSupported))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>JobImpressionsSupported</code> itself
+ * @return The class <code>JobImpressionsSupported</code> itself.
*/
public Class getCategory()
{
@@ -70,7 +104,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "job-impressions-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobMediaSheetsSupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobMediaSheetsSupported.java,v
retrieving revision 1.4
diff -u -r1.4 JobMediaSheetsSupported.java
--- javax/print/attribute/standard/JobMediaSheetsSupported.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/JobMediaSheetsSupported.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* JobMediaSheetsSupported.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -42,7 +42,15 @@
/**
+ * The <code>JobMediaSheetsSupported</code> printing attribute specifies the
+ * supported range of values for the
+ * address@hidden javax.print.attribute.standard.JobMediaSheets} attribute.
+ * <p>
+ * <b>IPP Compatibility:</b> JobMediaSheetsSupported is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class JobMediaSheetsSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute
@@ -50,17 +58,43 @@
private static final long serialVersionUID = 2953685470388672940L;
/**
- * Constructs a <code>JobMediaSheetsSupported</code> object.
+ * Constructs a <code>JobMediaSheetsSupported</code> object with the
+ * given range of supported job media sheets values.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound <= upperbound
+ * and lowerBound < 1
*/
public JobMediaSheetsSupported(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerBound may not be less than 1");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if (! (obj instanceof JobMediaSheetsSupported))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>JobMediaSheetsSupported</code> itself
+ * @return The class <code>JobMediaSheetsSupported</code> itself.
*/
public Class getCategory()
{
@@ -70,7 +104,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "job-media-sheets-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/PageRanges.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PageRanges.java,v
retrieving revision 1.4
diff -u -r1.4 PageRanges.java
--- javax/print/attribute/standard/PageRanges.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/PageRanges.java 17 Dec 2005 20:23:57
-0000
@@ -1,5 +1,5 @@
/* PageRanges.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,7 +44,19 @@
import javax.print.attribute.SetOfIntegerSyntax;
/**
+ * The <code>PageRanges</code> printing attribute specifies the
+ * range(s) of pages to be printed in a print job.
+ * <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> PageRanges is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class PageRanges extends SetOfIntegerSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute
@@ -52,33 +64,95 @@
private static final long serialVersionUID = 8639895197656148392L;
/**
- * Constructs a <code>PageRanges</code> object.
+ * Constructs a <code>PageRanges</code> object with only one
+ * page to be printed.
+ *
+ * @param member the only page to be printed.
+ *
+ * @exception IllegalArgumentException if member is < 1
*/
public PageRanges(int member)
{
super(member);
+
+ if (member < 1)
+ throw new IllegalArgumentException("member may not be less than 1");
}
/**
- * Constructs a <code>PageRanges</code> object.
+ * Constructs a <code>PageRanges</code> object with a set
+ * of ranges to be printed.
+ *
+ * @param members the page ranges to be printed.
+ *
+ * @exception IllegalArgumentException if any element is invalid
+ * @exception NullPointerException if members is <code>null</code> or any
+ * element of members is <code>null</code>.
*/
public PageRanges(int[][] members)
{
super(members);
+
+ if (members == null)
+ throw new NullPointerException("members may not be null");
}
/**
- * Constructs a <code>PageRanges</code> object.
+ * Constructs a <code>PageRanges</code> object with the
+ * given single range of pages to be printed.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound <= upperbound
+ * and lowerBound < 1
*/
public PageRanges(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerbound may not be less than 1");
+ }
+
+ /**
+ * Constructs a <code>PageRanges</code> object with a set
+ * of ranges to be printed in string array form.
+ *
+ * @param members the page ranges to be printed in string form.
+ *
+ * @exception IllegalArgumentException if any element is invalid.
+ * @exception NullPointerException if members is <code>null</code> or any
+ * element of members is <code>null</code>.
+ */
+ public PageRanges(String members)
+ {
+ super(members);
+
+ if (members == null)
+ throw new NullPointerException("members may not be null");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if (! (obj instanceof PageRanges))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>PageRanges</code> itself
+ * @return The class <code>PageRanges</code> itself.
*/
public Class getCategory()
{
@@ -88,7 +162,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "page-ranges".
*/
public String getName()
{
Index: javax/print/attribute/standard/NumberUpSupported.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/NumberUpSupported.java,v
retrieving revision 1.4
diff -u -r1.4 NumberUpSupported.java
--- javax/print/attribute/standard/NumberUpSupported.java 2 Jul 2005
20:32:46 -0000 1.4
+++ javax/print/attribute/standard/NumberUpSupported.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* NumberUpSupported.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -42,7 +42,15 @@
/**
+ * The <code>NumberUpSupported</code> printing attribute specifies the
+ * supported value or range of values for the
+ * address@hidden javax.print.attribute.standard.NumberUp} attribute.
+ * <p>
+ * <b>IPP Compatibility:</b> NumberUpSupported is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class NumberUpSupported extends SetOfIntegerSyntax
implements SupportedValuesAttribute
@@ -50,33 +58,75 @@
private static final long serialVersionUID = -1041573395759141805L;
/**
- * Constructs a <code>NumberUp</code> object.
+ * Constructs a <code>NumberUpSupported</code> object.
+ *
+ * @param member the only one value supported for number up.
+ *
+ * @exception IllegalArgumentException if member is < 1
*/
public NumberUpSupported(int member)
{
super(member);
+
+ if (member < 1)
+ throw new IllegalArgumentException("member may not be less than 1");
}
/**
- * Constructs a <code>NumberUp</code> object.
+ * Constructs a <code>NumberUpSupported</code> object.
+ *
+ * @param members the members supported for number up.
+ *
+ * @exception IllegalArgumentException if any element is invalid
+ * @exception NullPointerException if members is <code>null</code> or any
+ * element of members is <code>null</code>.
*/
public NumberUpSupported(int[][] members)
{
super(members);
+
+ if (members == null)
+ throw new NullPointerException("members may not be null");
}
/**
- * Constructs a <code>NumberUp</code> object.
+ * Constructs a <code>NumberUpSupported</code> object with the
+ * given range for supported number up values.
+ *
+ * @param lowerBound the lower bound value
+ * @param upperBound the upper bound value
+ *
+ * @exception IllegalArgumentException if lowerBound <= upperbound
+ * and lowerBound < 1
*/
public NumberUpSupported(int lowerBound, int upperBound)
{
super(lowerBound, upperBound);
+
+ if (lowerBound < 1)
+ throw new IllegalArgumentException("lowerBound may not be less than 1");
+ }
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if (! (obj instanceof NumberUpSupported))
+ return false;
+
+ return super.equals(obj);
}
/**
* Returns category of this class.
*
- * @return the class <code>NumberUpSupported</code> itself
+ * @return The class <code>NumberUpSupported</code> itself.
*/
public Class getCategory()
{
@@ -86,7 +136,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "number-up-supported".
*/
public String getName()
{
Index: javax/print/attribute/standard/JobHoldUntil.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/JobHoldUntil.java,v
retrieving revision 1.5
diff -u -r1.5 JobHoldUntil.java
--- javax/print/attribute/standard/JobHoldUntil.java 2 Jul 2005 20:32:46
-0000 1.5
+++ javax/print/attribute/standard/JobHoldUntil.java 17 Dec 2005 20:23:57
-0000
@@ -1,5 +1,5 @@
/* JobHoldUntil.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -45,6 +45,19 @@
import javax.print.attribute.PrintRequestAttribute;
/**
+ * The <code>JobHoldUntil</code> attribute specifies the date
+ * and the time at which a print job must become a candidate
+ * for printing.
+ * <p>
+ * <b>IPP Compatibility:</b> JobHoldUntil is an IPP 1.1 attribute.
+ * However the attribute in IPP is based on keywords of named
+ * time periods like day-time or evening. It will depend on the
+ * concrete implementation of a print service how a mapping of the
+ * detailed provided date and time of this attribute to the named
+ * keyword or an alternate extension attribute will be done. E.g.
+ * CUPS supports also a HH:MM format as extension to the keywords.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
*/
public final class JobHoldUntil extends DateTimeSyntax
@@ -65,11 +78,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 +96,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>JobHoldUntil</code> itself
+ * @return The class <code>JobHoldUntil</code> itself.
*/
public Class getCategory()
{
@@ -90,9 +104,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "job-hold-until"
+ * @return The name "job-hold-until".
*/
public String getName()
{
Index: javax/print/attribute/standard/DateTimeAtProcessing.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/DateTimeAtProcessing.java,v
retrieving revision 1.5
diff -u -r1.5 DateTimeAtProcessing.java
--- javax/print/attribute/standard/DateTimeAtProcessing.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/DateTimeAtProcessing.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* DateTimeAtProcessing.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.
@@ -44,6 +44,14 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>DateTimeAtProcessing</code> attribute specifies the date
+ * and the time at which a print job started processing.
+ * <p>
+ * <b>IPP Compatibility:</b> DateTimeAtProcessing is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.DateTimeAtCompleted
+ * @see javax.print.attribute.standard.DateTimeAtCreation
+ *
* @author Michael Koch (address@hidden)
*/
public final class DateTimeAtProcessing extends DateTimeSyntax
@@ -64,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)
{
@@ -81,7 +90,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>DateTimeAtProcessing</code> itself
+ * @return The class <code>DateTimeAtProcessing</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +98,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "date-time-at-processing"
+ * @return The name "date-time-at-processing".
*/
public String getName()
{
Index: javax/print/attribute/standard/DateTimeAtCompleted.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/DateTimeAtCompleted.java,v
retrieving revision 1.5
diff -u -r1.5 DateTimeAtCompleted.java
--- javax/print/attribute/standard/DateTimeAtCompleted.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/DateTimeAtCompleted.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* DateTimeAtCompleted.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.
@@ -44,6 +44,14 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>DateTimeAtCompleted</code> attribute specifies the date and
+ * the time at which a print job completed (or was canceled or aborted).
+ * <p>
+ * <b>IPP Compatibility:</b> DateTimeAtCompleted is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.DateTimeAtCreation
+ * @see javax.print.attribute.standard.DateTimeAtProcessing
+ *
* @author Michael Koch (address@hidden)
*/
public final class DateTimeAtCompleted extends DateTimeSyntax
@@ -64,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)
{
@@ -81,7 +90,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>DateTimeAtCompleted</code> itself
+ * @return The class <code>DateTimeAtCompleted</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +98,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "date-time-at-completed"
+ * @return The name "date-time-at-completed".
*/
public String getName()
{
Index: javax/print/attribute/standard/DateTimeAtCreation.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/DateTimeAtCreation.java,v
retrieving revision 1.5
diff -u -r1.5 DateTimeAtCreation.java
--- javax/print/attribute/standard/DateTimeAtCreation.java 2 Jul 2005
20:32:46 -0000 1.5
+++ javax/print/attribute/standard/DateTimeAtCreation.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
/* DateTimeAtCreation.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.
@@ -44,6 +44,14 @@
import javax.print.attribute.PrintJobAttribute;
/**
+ * The <code>DateTimeAtCreation</code> attribute specifies the
+ * date and the time at which a print job was created.
+ * <p>
+ * <b>IPP Compatibility:</b> DateTimeAtCreation is an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.attribute.standard.DateTimeAtCompleted
+ * @see javax.print.attribute.standard.DateTimeAtProcessing
+ *
* @author Michael Koch (address@hidden)
*/
public final class DateTimeAtCreation extends DateTimeSyntax
@@ -64,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)
{
@@ -81,7 +90,7 @@
/**
* Returns category of this class.
*
- * @return the class <code>DateTimeAtCreation</code> itself
+ * @return The class <code>DateTimeAtCreation</code> itself.
*/
public Class getCategory()
{
@@ -89,9 +98,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "date-time-at-creation"
+ * @return The name "date-time-at-creation".
*/
public String getName()
{
Index: javax/print/attribute/standard/PrinterURI.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterURI.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterURI.java
--- javax/print/attribute/standard/PrinterURI.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/PrinterURI.java 17 Dec 2005 20:23:57
-0000
@@ -1,5 +1,5 @@
/* PrinterURI.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,7 +44,18 @@
import javax.print.attribute.URISyntax;
/**
+ * The <code>PrinterURI</code> attribute provides the URI of a printer.
+ * <p>
+ * The URI identifies the printer against all the other print services
+ * available. This attribute is used to direct a print service request
+ * to this specific printer.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterURI is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class PrinterURI extends URISyntax
implements PrintServiceAttribute
@@ -53,16 +64,35 @@
/**
* Constructs a <code>PrinterURI</code> object.
+ *
+ * @param uri the URI of the print service.
+ * @throws NullPointerException if the given uri is null.
*/
public PrinterURI(URI uri)
{
super(uri);
}
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof PrinterURI))
+ return false;
+
+ return super.equals(obj);
+ }
/**
* Returns category of this class.
*
- * @return the class <code>PrinterURI</code> itself
+ * @return The class <code>PrinterURI</code> itself.
*/
public Class getCategory()
{
@@ -70,9 +100,9 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "printer-uri"
+ * @return The name "printer-uri".
*/
public String getName()
{
Index: javax/print/attribute/standard/PrinterMoreInfoManufacturer.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterMoreInfoManufacturer.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterMoreInfoManufacturer.java
--- javax/print/attribute/standard/PrinterMoreInfoManufacturer.java 2 Jul
2005 20:32:46 -0000 1.4
+++ javax/print/attribute/standard/PrinterMoreInfoManufacturer.java 17 Dec
2005 20:23:57 -0000
@@ -1,5 +1,5 @@
/* PrinterMoreInfoManufacturer.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,7 +44,22 @@
import javax.print.attribute.URISyntax;
/**
+ * The <code>PrinterMoreInfoManufacturer</code> attribute provides a URI that
+ * can be used to obtain more information about the printer device type and
+ * its manufacturer.
+ * <p>
+ * The URI may for example contain a reference to a website of the
+ * manufacturer, containing informations and links to the latest firmware,
+ * printer drivers, manual etc. The information is normally intended for
+ * end users.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterMoreInfoManufacturer is an IPP 1.1
+ * attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class PrinterMoreInfoManufacturer extends URISyntax
implements PrintServiceAttribute
@@ -53,16 +68,35 @@
/**
* Constructs a <code>PrinterMoreInfoManufacturer</code> object.
+ *
+ * @param uri the URI of the information..
+ * @throws NullPointerException if the given uri is null.
*/
public PrinterMoreInfoManufacturer(URI uri)
{
super(uri);
}
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof PrinterMoreInfoManufacturer))
+ return false;
+
+ return super.equals(obj);
+ }
/**
* Returns category of this class.
*
- * @return the class <code>PrinterMoreInfoManufacturer</code> itself
+ * @return The class <code>PrinterMoreInfoManufacturer</code> itself.
*/
public Class getCategory()
{
@@ -72,7 +106,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "printer-more-info-manufacturer".
*/
public String getName()
{
Index: javax/print/attribute/standard/PrinterMoreInfo.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterMoreInfo.java,v
retrieving revision 1.4
diff -u -r1.4 PrinterMoreInfo.java
--- javax/print/attribute/standard/PrinterMoreInfo.java 2 Jul 2005 20:32:46
-0000 1.4
+++ javax/print/attribute/standard/PrinterMoreInfo.java 17 Dec 2005 20:23:57
-0000
@@ -1,5 +1,5 @@
/* PrinterMoreInfo.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,7 +44,18 @@
import javax.print.attribute.URISyntax;
/**
+ * The <code>PrinterMoreInfo</code> attribute provides a URI that can be used
+ * to obtain more information about the printer.
+ * <p>
+ * The URI may for example contain a reference to a HTML page with information.
+ * The information is normally intended for end users.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterMoreInfo is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class PrinterMoreInfo extends URISyntax
implements PrintServiceAttribute
@@ -53,16 +64,35 @@
/**
* Constructs a <code>PrinterMoreInfo</code> object.
+ *
+ * @param uri the URI of the information.
+ * @throws NullPointerException if the given uri is null.
*/
public PrinterMoreInfo(URI uri)
{
super(uri);
}
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof PrinterMoreInfo))
+ return false;
+
+ return super.equals(obj);
+ }
/**
* Returns category of this class.
*
- * @return the class <code>PrinterMoreInfo</code> itself
+ * @return The class <code>PrinterMoreInfo</code> itself.
*/
public Class getCategory()
{
@@ -72,7 +102,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "printer-more-info".
*/
public String getName()
{
Index: javax/print/attribute/standard/Destination.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/Destination.java,v
retrieving revision 1.3
diff -u -r1.3 Destination.java
--- javax/print/attribute/standard/Destination.java 2 Jul 2005 20:32:46
-0000 1.3
+++ javax/print/attribute/standard/Destination.java 17 Dec 2005 20:23:57
-0000
@@ -45,7 +45,27 @@
import javax.print.attribute.URISyntax;
/**
+ * The <code>Destination</code> attribute provides a URI for an alternate
+ * destination of the printing output.
+ * <p>
+ * As not an IPP attribute many print services will not support this
+ * attribute and only provide the printer device as a destination.
+ * An alternate output destination would be a file on the local harddisk
+ * given as a file scheme URI.
+ * </p>
+ * <p>
+ * If a print service does not support the destination attributes URI it
+ * will throw a PrintException. This exception may further implement the
+ * interface address@hidden javax.print.URIException}.
+ * </p>
+ * <p>
+ * <b>IPP Compatibility:</b> Destination is not an IPP 1.1 attribute.
+ * </p>
+ * @see javax.print.PrintException
+ * @see javax.print.URIException
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class Destination extends URISyntax
implements PrintJobAttribute, PrintRequestAttribute
@@ -54,16 +74,35 @@
/**
* Constructs a <code>Destination</code> object.
+ *
+ * @param uri the URI of the output destination.
+ * @throws NullPointerException if the given uri is null.
*/
public Destination(URI uri)
{
super(uri);
}
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof Destination))
+ return false;
+
+ return super.equals(obj);
+ }
/**
* Returns category of this class.
*
- * @return the class <code>Destination</code> itself
+ * @return The class <code>Destination</code> itself.
*/
public Class getCategory()
{
@@ -71,12 +110,12 @@
}
/**
- * Returns name of this class.
+ * Returns the name of this attribute.
*
- * @return the string "printer-uri"
+ * @return The name "spool-data-destination"
*/
public String getName()
{
- return "destination";
+ return "spool-data-destination";
}
}
Index: javax/print/attribute/standard/PrinterResolution.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/print/attribute/standard/PrinterResolution.java,v
retrieving revision 1.3
diff -u -r1.3 PrinterResolution.java
--- javax/print/attribute/standard/PrinterResolution.java 2 Jul 2005
20:32:46 -0000 1.3
+++ javax/print/attribute/standard/PrinterResolution.java 17 Dec 2005
20:23:57 -0000
@@ -1,5 +1,5 @@
-/* PrinterMoreInfoManufacturer.java --
- Copyright (C) 2004 Free Software Foundation, Inc.
+/* PrinterResolution.java --
+ Copyright (C) 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,7 +44,14 @@
/**
+ * The <code>PrinterResolution</code> printing attribute specifies a
+ * resolution supported by a print service or to be used by a print job.
+ * <p>
+ * <b>IPP Compatibility:</b> PrinterResolution is an IPP 1.1 attribute.
+ * </p>
+ *
* @author Michael Koch (address@hidden)
+ * @author Wolfgang Baer (address@hidden)
*/
public final class PrinterResolution extends ResolutionSyntax
implements DocAttribute, PrintJobAttribute, PrintRequestAttribute
@@ -52,18 +59,41 @@
private static final long serialVersionUID = 13090306561090558L;
/**
- * Constructs a <code>PrinterResolution</code> object.
+ * Creates a <code>PrinterResolution</code> object with the given cross
+ * feed and feed resolutions.
+ *
+ * @param crossFeedResolution the cross feed resolution
+ * @param feedResolution the feed resolution
+ * @param units the unit to use (e.g. address@hidden #DPCM} or
address@hidden #DPI})
+ *
+ * @exception IllegalArgumentException if either parameter is < 1
*/
public PrinterResolution(int crossFeedResolution, int feedResolution,
int units)
{
super(crossFeedResolution, feedResolution, units);
}
+
+ /**
+ * Tests if the given object is equal to this object.
+ *
+ * @param obj the object to test
+ *
+ * @return <code>true</code> if both objects are equal,
+ * <code>false</code> otherwise.
+ */
+ public boolean equals(Object obj)
+ {
+ if(! (obj instanceof PrinterResolution))
+ return false;
+
+ return super.equals(obj);
+ }
/**
* Returns category of this class.
*
- * @return the class <code>PrinterResolution</code> itself
+ * @return The class <code>PrinterResolution</code> itself.
*/
public Class getCategory()
{
@@ -73,7 +103,7 @@
/**
* Returns the name of this attribute.
*
- * @return the name
+ * @return The name "printer-resolution".
*/
public String getName()
{
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: Further updates for javax.print.attribute.standard,
Wolfgang Baer <=