diff options
Diffstat (limited to 'libjava/classpath/javax/print/attribute/AttributeSetUtilities.java')
| -rw-r--r-- | libjava/classpath/javax/print/attribute/AttributeSetUtilities.java | 87 |
1 files changed, 66 insertions, 21 deletions
diff --git a/libjava/classpath/javax/print/attribute/AttributeSetUtilities.java b/libjava/classpath/javax/print/attribute/AttributeSetUtilities.java index 6f0ffc10d7f..5d97c66f21a 100644 --- a/libjava/classpath/javax/print/attribute/AttributeSetUtilities.java +++ b/libjava/classpath/javax/print/attribute/AttributeSetUtilities.java @@ -39,12 +39,41 @@ package javax.print.attribute; import java.io.Serializable; +/** + * <code>AttributeSetUtilities</code> provides static methods for working + * with <code>AttributeSet</code>s. + * <p> + * For every type of an attribute set available in the Java Print Service API + * are methods provided to get an unmodifiable view of an attribute set. + * This unmodifiable view provides a read-only version of the attribute + * set which throws {@link javax.print.attribute.UnmodifiableSetException}s + * if state changing methods are invoked. + * </p> + * <p> + * Methods for getting a synchronized view of an attribute set are also + * available. This view provides synchronized (thread safe) access to the + * underlying wrapped attribute set. + * </P> + * <p> + * Three static methods for the implementation of own AttributeSets + * are provided, which verify that: + * <ul> + * <li>the given object is an attribute of the given interface.</li> + * <li>the category of given attribute is equals to a given category.</li> + * <li>the given object is a <code>Class</code> that implements the given + * interface name.</li> + * </ul> + * + */ public final class AttributeSetUtilities { /** * This class isn't intended to be instantiated. */ - private AttributeSetUtilities() {} + private AttributeSetUtilities() + { + // only static methods + } private static class UnmodifiableAttributeSet implements AttributeSet, Serializable @@ -287,7 +316,8 @@ public final class AttributeSetUtilities /** * Returns a synchronized view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to synchronize. + * @return The sychronized attribute set. */ public static AttributeSet synchronizedView(AttributeSet attributeSet) { @@ -297,7 +327,8 @@ public final class AttributeSetUtilities /** * Returns a synchronized view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to synchronize. + * @return The sychronized attribute set. */ public static DocAttributeSet synchronizedView(DocAttributeSet attributeSet) { @@ -307,7 +338,8 @@ public final class AttributeSetUtilities /** * Returns a synchronized view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to synchronize. + * @return The sychronized attribute set. */ public static PrintJobAttributeSet synchronizedView(PrintJobAttributeSet attributeSet) { @@ -317,7 +349,8 @@ public final class AttributeSetUtilities /** * Returns a synchronized view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to synchronize. + * @return The sychronized attribute set. */ public static PrintRequestAttributeSet synchronizedView(PrintRequestAttributeSet attributeSet) { @@ -327,7 +360,8 @@ public final class AttributeSetUtilities /** * Returns a synchronized view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to synchronize. + * @return The sychronized attribute set. */ public static PrintServiceAttributeSet synchronizedView(PrintServiceAttributeSet attributeSet) { @@ -337,7 +371,8 @@ public final class AttributeSetUtilities /** * Returns an unmodifiable view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to make unmodifiable. + * @return The unmodifiable attribute set. */ public static AttributeSet unmodifiableView(AttributeSet attributeSet) { @@ -347,7 +382,8 @@ public final class AttributeSetUtilities /** * Returns an unmodifiable view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to make unmodifiable. + * @return The unmodifiable attribute set. */ public static DocAttributeSet unmodifiableView(DocAttributeSet attributeSet) { @@ -357,7 +393,8 @@ public final class AttributeSetUtilities /** * Returns an unmodifiable view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to make unmodifiable. + * @return The unmodifiable attribute set. */ public static PrintJobAttributeSet unmodifiableView(PrintJobAttributeSet attributeSet) { @@ -367,7 +404,8 @@ public final class AttributeSetUtilities /** * Returns an unmodifiable view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to make unmodifiable. + * @return The unmodifiable attribute set. */ public static PrintRequestAttributeSet unmodifiableView(PrintRequestAttributeSet attributeSet) { @@ -377,7 +415,8 @@ public final class AttributeSetUtilities /** * Returns an unmodifiable view of the given attribute set. * - * @return the sychronized attribute set + * @param attributeSet the set to make unmodifiable. + * @return The unmodifiable attribute set. */ public static PrintServiceAttributeSet unmodifiableView(PrintServiceAttributeSet attributeSet) { @@ -386,8 +425,10 @@ public final class AttributeSetUtilities /** * Verifies that the given object is a <code>Class</code> that - * implements the given interface name. - * + * implements the given interface name and returns it casted. + * + * @param object the object to test. + * @param interfaceName the <code>Class</code> to verify against. * @return object casted to <code>Class</code> * * @exception ClassCastException if object is not a <code>Class</code> @@ -410,7 +451,10 @@ public final class AttributeSetUtilities /** * Verifies that the given object is an attribute of the given interface. - * + * and returns it casted to the interface type. + * + * @param object the object to test. + * @param interfaceName the <code>Class</code> to verify against. * @return the object casted to <code>Attribute</code> * * @exception ClassCastException if object is no instance of interfaceName. @@ -429,10 +473,11 @@ public final class AttributeSetUtilities } /** - * Verifies that the category of attribute is equals to category. - * - * @param category the category the atteribute should be - * @param attribute the attribute to verify + * Verifies that the category of attribute is equals to the given category + * class. + * + * @param category the category to test. + * @param attribute the attribute to verify. * * @exception IllegalArgumentException if the categories are not equal * @exception NullPointerException if category is null @@ -440,10 +485,10 @@ public final class AttributeSetUtilities public static void verifyCategoryForValue(Class category, Attribute attribute) { - if (category == null) - throw new NullPointerException("object may not be null"); + if (category == null || attribute == null) + throw new NullPointerException("category or attribute may not be null"); - if (category.equals(attribute.getCategory())) + if (!category.equals(attribute.getCategory())) throw new IllegalArgumentException ("category of attribute not equal to category"); } |