[cp-patches] Patch: API docs for javax/print/attribute Interfaces and Exception

[Wolfgang Baer]

Hi,

this adds documentation to the interfaces and one exception
in javax.print.attribute.

2005-11-12  Wolfgang Baer  <address@hidden>

        * javax/print/attribute/Attribute.java,
        javax/print/attribute/AttributeSet.java,
        javax/print/attribute/DocAttribute.java,
        javax/print/attribute/DocAttributeSet.java,
        javax/print/attribute/PrintJobAttribute.java,
        javax/print/attribute/PrintJobAttributeSet.java,
        javax/print/attribute/PrintRequestAttribute.java,
        javax/print/attribute/PrintRequestAttributeSet.java,
        javax/print/attribute/PrintServiceAttribute.java,
        javax/print/attribute/PrintServiceAttributeSet.java,
        javax/print/attribute/SupportedValuesAttribute.java,
        javax/print/attribute/UnmodifiableSetException.java:
        Added api documentation to class and method definitions.
        * javax/print/attribute/package.html: Included a package description.

OK to commit ?

Regards,
Wolfgang



Index: javax/print/attribute/Attribute.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/Attribute.java,v
retrieving revision 1.3
diff -u -r1.3 Attribute.java
--- javax/print/attribute/Attribute.java        2 Jul 2005 20:32:46 -0000       
1.3
+++ javax/print/attribute/Attribute.java        12 Nov 2005 19:36:28 -0000
@@ -1,5 +1,5 @@
 /* Attribute.java -- 
-   Copyright (C) 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -40,11 +40,27 @@
 import java.io.Serializable;
 
 /**
- * @author Michael Koch
+ * Base interface of every printing attribute of the Java Print Service API.
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface Attribute extends Serializable
 {
+  /**
+   * Returns the category of the printing attribute which is the specific
+   * attribute class implementing this interface.
+   * 
+   * @return The concrete address@hidden Class} instance of the attribute 
class.
+   */
   Class getCategory ();
 
+  /**
+   * Returns the descriptive name of the attribute category.
+   * 
+   * Implementations of the <code>Attribute</code> interfaces providing equal
+   * category values have to return equal name values.
+   * 
+   * @return The name of the attribute category.
+   */
   String getName ();
 }
Index: javax/print/attribute/AttributeSet.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/AttributeSet.java,v
retrieving revision 1.3
diff -u -r1.3 AttributeSet.java
--- javax/print/attribute/AttributeSet.java     2 Jul 2005 20:32:46 -0000       
1.3
+++ javax/print/attribute/AttributeSet.java     12 Nov 2005 19:36:28 -0000
@@ -1,5 +1,5 @@
 /* AttributeSet.java -- 
-   Copyright (C) 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,40 +38,159 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * <code>AttributeSet</code> is the top-level interface for sets of printing
+ * attributes in the Java Print Service API.
+ * <p>
+ * There are no duplicate values allowed in an attribute set and there is
+ * at most one attribute object contained per category type. Based on the
+ * address@hidden java.util.Map} interface the values of attribute sets are 
objects
+ * of type address@hidden javax.print.attribute.Attribute} and the entries are 
the
+ * categories as address@hidden java.lang.Class} instances.
+ * </p>
+ * <p>
+ * The following specialized types of <code>AttributeSet</code> are available:
+ * <ul>
+ *  <li>address@hidden javax.print.attribute.DocAttributeSet}</li>
+ *  <li>address@hidden javax.print.attribute.PrintRequestAttributeSet}</li>
+ *  <li>address@hidden javax.print.attribute.PrintJobAttributeSet}</li>
+ *  <li>address@hidden javax.print.attribute.PrintServiceAttributeSet}</li>
+ * </ul>
+ * </p>
+ * <p>
+ * Attribute sets may be unmodifiable depending on the context of usage. If 
+ * used as read-only attribute set modifying operations throw an 
+ * address@hidden javax.print.attribute.UnmodifiableSetException}.
+ * </p>
+ * <p>
+ * The Java Print Service API provides implementation classes for the existing
+ * attribute set interfaces but applications may use their own implementations.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface AttributeSet
 {
   /**
-   * Adds the specified attribute value to this attribute set
+   * Adds the specified attribute value to this attribute set 
    * if it is not already present.
+   * 
+   * This operation removes any existing attribute of the same category 
+   * before adding the given attribute to the set. 
+   * 
+   * @param attribute the attribute to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws NullPointerException if the attribute is <code>null</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
    */
   boolean add (Attribute attribute);
 
   /**
-   * Adds all of the elements in the specified set to this attribute.
+   * Adds all of the elements in the specified set to this attribute set.
+   * 
+   * @param attributes the set of attributes to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws UnmodifiableSetException if the set does not support modification.
+   * 
+   * @see #add(Attribute)
    */
   boolean addAll (AttributeSet attributes);
-
+  
+  /**
+   * Removes all attributes from this attribute set.
+   * 
+   * @throws UnmodifiableSetException if the set does not support modification.
+   */
   void clear ();
-
+  
+  /**
+   * Checks if this attributes set contains an attribute with the given 
+   * category.
+   * 
+   * @param category the category to test for.
+   * @return <code>true</code> if an attribute of the category is contained
+   * in the set, <code>false</code> otherwise.
+   */
   boolean containsKey (Class category);
-
+  
+  /**
+   * Checks if this attribute set contains the given attribute.
+   * 
+   * @param attribute the attribute to test for.
+   * @return <code>true</code> if the attribute is contained in the set,
+   * <code>false</code> otherwise.
+   */
   boolean containsValue (Attribute attribute);
   
+  /**
+   * Tests this set for equality with the given object. <code>true</code> is
+   * returned, if the given object is also of type <code>AttributeSet</code>
+   * and the contained attributes are the same as in this set.
+   * 
+   * @param obj the Object to test.
+   * @return <code>true</code> if equal, false otherwise.
+   */
   boolean equals (Object obj);
-
-  Attribute get (Class Category);
-
+  
+  /**
+   * Returns the attribute object contained in this set for the given attribute
+   * category. 
+   * 
+   * @param category the category of the attribute. A <code>Class</code> 
+   * instance of a class implementing the <code>Attribute</code> interface. 
+   * @return The attribute for this category or <code>null</code> if no 
+   * attribute is contained for the given category. 
+   * @throws NullPointerException if category is null.
+   * @throws ClassCastException if category is not implementing 
+   * <code>Attribute</code>.
+   */
+  Attribute get (Class category);
+  
+  /**
+   * Returns the hashcode value. The hashcode value is the sum of all hashcodes
+   * of the attributes contained in this set.
+   * 
+   * @return The hashcode for this attribute set.
+   */
   int hashCode ();
-
+  
+  /**
+   * Checks if the attribute set is empty.
+   *
+   * @return <code>true</code> if the attribute set is empty, false otherwise.
+   */
   boolean isEmpty ();
 
+  /**
+   * Removes the given attribute from the set. If the given attribute is 
<code>null</code>
+   * nothing is done and <code>false</code> is returned.
+   * 
+   * @param attribute the attribute to remove.  
+   * @return <code>true</code> if removed, false in all other cases. 
+   * @throws UnmodifiableSetException if the set does not support modification.
+   */
   boolean remove (Attribute attribute);
-
+  
+  /**
+   * Removes the attribute entry of the given category from the set. If the 
given
+   * category is <code>null</code> nothing is done and <code>false</code> is 
returned.
+   * 
+   * @param category the category of the entry to be removed.
+   * @return <code>true</code> if an attribute is removed, false in all other 
cases. 
+   * @throws UnmodifiableSetException if the set does not support modification.
+   */
   boolean remove (Class category);
-
+  
+  /**
+   * Returns the number of elements in this attribute set.
+   *
+   * @return The number of elements.
+   */
   int size ();
-
+  
+  /**
+   * Returns the content of the attribute set as an array
+   *
+   * @return An array of attributes.
+   */
   Attribute[] toArray ();
 }
Index: javax/print/attribute/DocAttribute.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/DocAttribute.java,v
retrieving revision 1.2
diff -u -r1.2 DocAttribute.java
--- javax/print/attribute/DocAttribute.java     2 Jul 2005 20:32:46 -0000       
1.2
+++ javax/print/attribute/DocAttribute.java     12 Nov 2005 19:36:28 -0000
@@ -1,5 +1,5 @@
 /* DocAttribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,8 +38,23 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Marker interface for all attribute classes describing attributes of 
+ * a address@hidden javax.print.Doc} object. 
+ * <p>
+ * Instances of implementing attribute classes may be collected in a 
+ * address@hidden javax.print.attribute.DocAttributeSet}. 
+ * </p><p>
+ * Attributes attached to a address@hidden javax.print.Doc} instance specify 
how the
+ * data should be printed. 
+ * For example address@hidden javax.print.attribute.standard.Chromaticity} can 
be 
+ * used to specify that a doc should be printed in color or monochrome.
+ * </p>
+ * 
+ * @see javax.print.attribute.DocAttributeSet
+ * 
+ * @author Michael Koch  (address@hidden)
  */
 public interface DocAttribute extends Attribute
 {
+  // Marker interface
 }
Index: javax/print/attribute/DocAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/DocAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 DocAttributeSet.java
--- javax/print/attribute/DocAttributeSet.java  2 Jul 2005 20:32:46 -0000       
1.2
+++ javax/print/attribute/DocAttributeSet.java  12 Nov 2005 19:36:28 -0000
@@ -1,5 +1,5 @@
 /* DocAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,18 +38,45 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * <code>DocAttributeSet</code> specifies an attribute set which only
+ * allows printing attributes of type 
+ * address@hidden javax.print.attribute.DocAttribute}.
+ * <p>
+ * The methods address@hidden #add(Attribute)} and address@hidden 
#addAll(AttributeSet)} are
+ * respecified in this interface to indicate that only 
+ * <code>DocAttribute</code> instances are allowed in this set.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface DocAttributeSet extends AttributeSet
 {
   /**
-   * Adds the specified attribute value to this attribute set
+   * Adds the specified attribute value to this attribute set 
    * if it is not already present.
+   * 
+   * This operation removes any existing attribute of the same category 
+   * before adding the given attribute. 
+   * 
+   * @param attribute the attribute to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if attribute is not of type 
+   * <code>DocAttribute</code>.
+   * @throws NullPointerException if the attribute is <code>null</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
    */
   boolean add (Attribute attribute);
 
   /**
-   * Adds all of the elements in the specified set to this attribute.
+   * Adds all of the elements in the specified set to this attribute set.
+   * 
+   * @param attributes the set of attributes to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if one of the attributes is not of type 
+   * <code>DocAttribute</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
+   * 
+   * @see #add(Attribute)
    */
   boolean addAll (AttributeSet attributes);
 }
Index: javax/print/attribute/PrintJobAttribute.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintJobAttribute.java,v
retrieving revision 1.2
diff -u -r1.2 PrintJobAttribute.java
--- javax/print/attribute/PrintJobAttribute.java        2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/PrintJobAttribute.java        12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintJobAttribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,8 +38,23 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Marker interface for all attribute classes describing attributes or the
+ * status of a (address@hidden javax.print.DocPrintJob} object. 
+ * <p>
+ * Instances of implementing attribute classes may be collected in a 
+ * address@hidden javax.print.attribute.PrintJobAttributeSet}.
+ * </p><p>
+ * A print service uses attributes of this type to inform about the status
+ * of a print job. 
+ * For example address@hidden 
javax.print.attribute.standard.DateTimeAtProcessing} 
+ * is used to report at which date and time a job has started processing. 
+ * </p>
+ * 
+ * @see javax.print.attribute.PrintJobAttributeSet
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintJobAttribute extends Attribute
 {
+  // Marker interface
 }
Index: javax/print/attribute/PrintJobAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintJobAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 PrintJobAttributeSet.java
--- javax/print/attribute/PrintJobAttributeSet.java     2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/PrintJobAttributeSet.java     12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintJobAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,18 +38,45 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * <code>PrintJobAttributeSet</code> specifies an attribute set which only
+ * allows printing attributes of type 
+ * address@hidden javax.print.attribute.PrintJobAttribute}.
+ * <p>
+ * The methods address@hidden #add(Attribute)} and address@hidden 
#addAll(AttributeSet)} are
+ * respecified in this interface to indicate that only 
+ * <code>PrintJobAttribute</code> instances are allowed in this set.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintJobAttributeSet extends AttributeSet
 {
   /**
-   * Adds the specified attribute value to this attribute set
+   * Adds the specified attribute value to this attribute set 
    * if it is not already present.
+   * 
+   * This operation removes any existing attribute of the same category 
+   * before adding the given attribute. 
+   * 
+   * @param attribute the attribute to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if attribute is not of type 
+   * <code>PrintJobAttribute</code>.
+   * @throws NullPointerException if the attribute is <code>null</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
    */
   boolean add (Attribute attribute);
 
   /**
-   * Adds all of the elements in the specified set to this attribute.
+   * Adds all of the elements in the specified set to this attribute set.
+   * 
+   * @param attributes the set of attributes to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if one of the attributes is not of type 
+   * <code>PrintJobAttribute</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
+   * 
+   * @see #add(Attribute)
    */
   boolean addAll (AttributeSet attributes);
 }
Index: javax/print/attribute/PrintRequestAttribute.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintRequestAttribute.java,v
retrieving revision 1.2
diff -u -r1.2 PrintRequestAttribute.java
--- javax/print/attribute/PrintRequestAttribute.java    2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/PrintRequestAttribute.java    12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintRequestAttribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,8 +38,18 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Marker interface for all attribute classes which specify a requested
+ * attribute of address@hidden javax.print.DocPrintJob} object. 
+ * <p>
+ * Instances of implementing attribute classes may be collected in a 
+ * address@hidden javax.print.attribute.PrintRequestAttributeSet}.
+ * </p>
+ * 
+ * @see javax.print.attribute.PrintRequestAttributeSet
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintRequestAttribute extends Attribute
 {
+  // Marker interface
 }
Index: javax/print/attribute/PrintRequestAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintRequestAttributeSet.java,v
retrieving revision 1.3
diff -u -r1.3 PrintRequestAttributeSet.java
--- javax/print/attribute/PrintRequestAttributeSet.java 2 Jul 2005 20:32:46 
-0000       1.3
+++ javax/print/attribute/PrintRequestAttributeSet.java 12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintRequestAttributeSet.java -- 
-   Copyright (C) 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,18 +38,45 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * <code>PrintRequestAttributeSet</code> specifies an attribute set which only
+ * allows printing attributes of type 
+ * address@hidden javax.print.attribute.PrintRequestAttribute}.
+ * <p>
+ * The methods address@hidden #add(Attribute)} and address@hidden 
#addAll(AttributeSet)} are
+ * respecified in this interface to indicate that only 
+ * <code>PrintRequestAttribute</code> instances are allowed in this set.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintRequestAttributeSet extends AttributeSet
 {
   /**
-   * Adds the specified attribute value to this attribute set
+   * Adds the specified attribute value to this attribute set 
    * if it is not already present.
+   * 
+   * This operation removes any existing attribute of the same category 
+   * before adding the given attribute. 
+   * 
+   * @param attribute the attribute to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if attribute is not of type 
+   * <code>PrintRequestAttribute</code>.
+   * @throws NullPointerException if the attribute is <code>null</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
    */
   boolean add (Attribute attribute);
 
   /**
-   * Adds all of the elements in the specified set to this attribute.
+   * Adds all of the elements in the specified set to this attribute set.
+   * 
+   * @param attributes the set of attributes to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if one of the attributes is not of type 
+   * <code>PrintRequestAttribute</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
+   * 
+   * @see #add(Attribute)
    */
   boolean addAll (AttributeSet attributes);
 }
Index: javax/print/attribute/PrintServiceAttribute.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintServiceAttribute.java,v
retrieving revision 1.2
diff -u -r1.2 PrintServiceAttribute.java
--- javax/print/attribute/PrintServiceAttribute.java    2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/PrintServiceAttribute.java    12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintServiceAttribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,8 +38,23 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Marker interface for all attribute classes describing parameters
+ * or the status of a address@hidden javax.print.PrintService}. 
+ * <p>
+ * Instances of implementing attribute classes may be collected in a 
+ * address@hidden javax.print.attribute.PrintServiceAttributeSet}.
+ * </p><p>
+ * A print service uses attributes of this type to inform about the status
+ * or the specific capabilities of itself. 
+ * For example address@hidden javax.print.attribute.standard.PagesPerMinute} 
is used
+ * to specify the average printable pages per minute of the print service. 
+ * </p>
+ * 
+ * @see javax.print.attribute.PrintServiceAttributeSet
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintServiceAttribute extends Attribute
 {
+  // Marker interface
 }
Index: javax/print/attribute/PrintServiceAttributeSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/PrintServiceAttributeSet.java,v
retrieving revision 1.2
diff -u -r1.2 PrintServiceAttributeSet.java
--- javax/print/attribute/PrintServiceAttributeSet.java 2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/PrintServiceAttributeSet.java 12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
 /* PrintServiceAttributeSet.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,18 +38,45 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * <code>PrintServiceAttributeSet</code> specifies an attribute set which only
+ * allows printing attributes of type 
+ * address@hidden javax.print.attribute.PrintServiceAttribute}.
+ * <p>
+ * The methods address@hidden #add(Attribute)} and address@hidden 
#addAll(AttributeSet)} are
+ * respecified in this interface to indicate that only 
+ * <code>PrintServiceAttribute</code> instances are allowed in this set.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface PrintServiceAttributeSet extends AttributeSet
 {
   /**
-   * Adds the specified attribute value to this attribute set
+   * Adds the specified attribute value to this attribute set 
    * if it is not already present.
+   * 
+   * This operation removes any existing attribute of the same category 
+   * before adding the given attribute. 
+   * 
+   * @param attribute the attribute to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if attribute is not of type 
+   * <code>PrintServiceAttribute</code>.
+   * @throws NullPointerException if the attribute is <code>null</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
    */
   boolean add (Attribute attribute);
 
   /**
-   * Adds all of the elements in the specified set to this attribute.
+   * Adds all of the elements in the specified set to this attribute set.
+   * 
+   * @param attributes the set of attributes to add.
+   * @return <code>true</code> if the set is changed, false otherwise.
+   * @throws ClassCastException if one of the attributes is not of type 
+   * <code>PrintServiceAttribute</code>.
+   * @throws UnmodifiableSetException if the set does not support modification.
+   * 
+   * @see #add(Attribute)
    */
   boolean addAll (AttributeSet attributes);
 }
Index: javax/print/attribute/SupportedValuesAttribute.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/SupportedValuesAttribute.java,v
retrieving revision 1.2
diff -u -r1.2 SupportedValuesAttribute.java
--- javax/print/attribute/SupportedValuesAttribute.java 2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/SupportedValuesAttribute.java 12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
-/* Attribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+/* SupportedValuesAttribute.java -- 
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -38,8 +38,22 @@
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Marker interface for all attribute classes specifying the 
+ * supported/allowed values for another printing attribute class.
+ * <p>
+ * A address@hidden javax.print.PrintService} instance for example provides
+ * printing attribute classes implementing this interface to indicate
+ * that a specific attribute type is supported and if the supported values.
+ * </p><p>
+ * E.g. a address@hidden javax.print.attribute.standard.JobPrioritySupported}
+ * instance indicates that the attribute class 
+ * address@hidden javax.print.attribute.standard.JobPriority} is supported and
+ * provides the number of the possible priority levels.
+ * </p>
+ * 
+ * @author Michael Koch (address@hidden)
  */
 public interface SupportedValuesAttribute extends Attribute
 {
+  // Marker interface
 }
Index: javax/print/attribute/UnmodifiableSetException.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/print/attribute/UnmodifiableSetException.java,v
retrieving revision 1.2
diff -u -r1.2 UnmodifiableSetException.java
--- javax/print/attribute/UnmodifiableSetException.java 2 Jul 2005 20:32:46 
-0000       1.2
+++ javax/print/attribute/UnmodifiableSetException.java 12 Nov 2005 19:36:28 
-0000
@@ -1,5 +1,5 @@
-/* Attribute.java -- 
-   Copyright (C) 2003 Free Software Foundation, Inc.
+/* UnmodifiableSetException.java -- 
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -35,10 +35,14 @@
 obligated to do so.  If you do not wish to do so, delete this
 exception statement from your version. */
 
+
 package javax.print.attribute;
 
 /**
- * @author Michael Koch
+ * Exception which is thrown if an operation on an unmodifiable set
+ * is invoked.
+ * 
+ * @author Michael Koch (address@hidden)
  *
  * @since 1.4
  */
@@ -56,7 +60,7 @@
    * Creates a <code>UnmodifiableSetException</code>
    * with the given message.
    *
-   * @param message the message for the exception
+   * @param message the message of the exception
    */
   public UnmodifiableSetException(String message)
   {
Index: javax/print/attribute/package.html
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/print/attribute/package.html,v
retrieving revision 1.2
diff -u -r1.2 package.html
--- javax/print/attribute/package.html  2 Jul 2005 20:32:46 -0000       1.2
+++ javax/print/attribute/package.html  12 Nov 2005 19:36:28 -0000
@@ -1,6 +1,6 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <!-- package.html - describes classes in javax.print.attribute package.
-   Copyright (C) 2003 Free Software Foundation, Inc.
+   Copyright (C) 2003, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -40,7 +40,10 @@
 <head><title>GNU Classpath - javax.print.attribute</title></head>
 
 <body>
-<p></p>
-
+<p>Provides classes and interfaces describing the roles and 
+syntax of attribute objects in the Java Print Service API.</p>
+<p>
+<b>Since:</b> 1.4
+</p>
 </body>
 </html>