< prev index next >

src/java.desktop/share/classes/javax/print/attribute/AttributeSetUtilities.java

Print this page


   1 /*
   2  * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 
  27 package javax.print.attribute;
  28 
  29 import java.io.Serializable;
  30 
  31 /**
  32  * Class AttributeSetUtilities provides static methods for manipulating
  33  * AttributeSets.
  34  * <ul>
  35  * <li>Methods for creating unmodifiable and synchronized views of attribute
  36  * sets.
  37  * <li>operations useful for building
  38  * implementations of interface {@link AttributeSet AttributeSet}
  39  * </ul>
  40  * <P>
  41  * An <B>unmodifiable view</B> <I>U</I> of an AttributeSet <I>S</I> provides a
  42  * client with "read-only" access to <I>S</I>. Query operations on <I>U</I>
  43  * "read through" to <I>S</I>; thus, changes in <I>S</I> are reflected in
  44  * <I>U</I>. However, any attempt to modify <I>U</I>,
  45  *  results in an UnmodifiableSetException.
  46  * The unmodifiable view object <I>U</I> will be serializable if the
  47  * attribute set object <I>S</I> is serializable.
  48  * <P>
  49  * A <B>synchronized view</B> <I>V</I> of an attribute set <I>S</I> provides a
  50  * client with synchronized (multiple thread safe) access to <I>S</I>. Each
  51  * operation of <I>V</I> is synchronized using <I>V</I> itself as the lock
  52  * object and then merely invokes the corresponding operation of <I>S</I>. In
  53  * order to guarantee mutually exclusive access, it is critical that all
  54  * access to <I>S</I> is accomplished through <I>V</I>. The synchronized view
  55  * object <I>V</I> will be serializable if the attribute set object <I>S</I>
  56  * is serializable.
  57  * <P>
  58  * As mentioned in the package description of javax.print, a null reference
  59  * parameter to methods is
  60  * incorrect unless explicitly documented on the method as having a meaningful
  61  * interpretation.  Usage to the contrary is incorrect coding and may result in
  62  * a run time exception either immediately
  63  * or at some later time. IllegalArgumentException and NullPointerException
  64  * are examples of typical and acceptable run time exceptions for such cases.
  65  *
  66  * @author  Alan Kaminsky
  67  */
  68 public final class AttributeSetUtilities {
  69 
  70     /* Suppress default constructor, ensuring non-instantiability.

  71      */
  72     private AttributeSetUtilities() {
  73     }
  74 
  75     /**


  76       * @serial include
  77       */
  78     private static class UnmodifiableAttributeSet
  79         implements AttributeSet, Serializable {




  80         private static final long serialVersionUID = -6131802583863447813L;
  81 



  82         private AttributeSet attrset;
  83 
  84         /* Unmodifiable view of the underlying attribute set.



  85          */
  86         public UnmodifiableAttributeSet(AttributeSet attributeSet) {
  87 
  88             attrset = attributeSet;
  89         }
  90 
  91         public Attribute get(Class<?> key) {
  92             return attrset.get(key);
  93         }
  94 
  95         public boolean add(Attribute attribute) {
  96             throw new UnmodifiableSetException();
  97         }
  98 
  99         public synchronized boolean remove(Class<?> category) {
 100             throw new UnmodifiableSetException();
 101         }
 102 
 103         public boolean remove(Attribute attribute) {
 104             throw new UnmodifiableSetException();


 122 
 123         public Attribute[] toArray() {
 124             return attrset.toArray();
 125         }
 126 
 127         public void clear() {
 128             throw new UnmodifiableSetException();
 129         }
 130 
 131         public boolean isEmpty() {
 132             return attrset.isEmpty();
 133         }
 134 
 135         public boolean equals(Object o) {
 136             return attrset.equals (o);
 137         }
 138 
 139         public int hashCode() {
 140             return attrset.hashCode();
 141         }
 142 
 143     }
 144 
 145     /**


 146       * @serial include
 147       */
 148     private static class UnmodifiableDocAttributeSet
 149         extends UnmodifiableAttributeSet
 150         implements DocAttributeSet, Serializable {




 151         private static final long serialVersionUID = -6349408326066898956L;
 152 





 153         public UnmodifiableDocAttributeSet(DocAttributeSet attributeSet) {
 154 
 155             super (attributeSet);
 156         }
 157     }
 158 
 159     /**


 160       * @serial include
 161       */
 162     private static class UnmodifiablePrintRequestAttributeSet
 163         extends UnmodifiableAttributeSet
 164         implements PrintRequestAttributeSet, Serializable
 165     {




 166         private static final long serialVersionUID = 7799373532614825073L;






 167         public UnmodifiablePrintRequestAttributeSet
 168             (PrintRequestAttributeSet attributeSet) {
 169 
 170             super (attributeSet);
 171         }
 172     }
 173 
 174     /**


 175       * @serial include
 176       */
 177     private static class UnmodifiablePrintJobAttributeSet
 178         extends UnmodifiableAttributeSet
 179         implements PrintJobAttributeSet, Serializable
 180     {



 181         private static final long serialVersionUID = -8002245296274522112L;






 182         public UnmodifiablePrintJobAttributeSet
 183             (PrintJobAttributeSet attributeSet) {
 184 
 185             super (attributeSet);
 186         }
 187     }
 188 
 189     /**


 190       * @serial include
 191       */
 192     private static class UnmodifiablePrintServiceAttributeSet
 193         extends UnmodifiableAttributeSet
 194         implements PrintServiceAttributeSet, Serializable
 195     {



 196         private static final long serialVersionUID = -7112165137107826819L;






 197         public UnmodifiablePrintServiceAttributeSet
 198             (PrintServiceAttributeSet attributeSet) {
 199 
 200             super (attributeSet);
 201         }
 202     }
 203 
 204     /**
 205      * Creates an unmodifiable view of the given attribute set.
 206      *
 207      * @param  attributeSet  Underlying attribute set.
 208      *
 209      * @return  Unmodifiable view of {@code attributeSet}.
 210      *
 211      * @exception  NullPointerException
 212      *     Thrown if {@code attributeSet} is null. Null is never a
 213      */
 214     public static AttributeSet unmodifiableView(AttributeSet attributeSet) {
 215         if (attributeSet == null) {
 216             throw new NullPointerException();
 217         }
 218 
 219         return new UnmodifiableAttributeSet(attributeSet);
 220     }
 221 
 222     /**
 223      * Creates an unmodifiable view of the given doc attribute set.
 224      *
 225      * @param  attributeSet  Underlying doc attribute set.
 226      *
 227      * @return  Unmodifiable view of {@code attributeSet}.
 228      *
 229      * @exception  NullPointerException
 230      *     Thrown if {@code attributeSet} is null.
 231      */
 232     public static DocAttributeSet unmodifiableView
 233         (DocAttributeSet attributeSet) {
 234         if (attributeSet == null) {
 235             throw new NullPointerException();
 236         }
 237         return new UnmodifiableDocAttributeSet(attributeSet);
 238     }
 239 
 240     /**
 241      * Creates an unmodifiable view of the given print request attribute set.
 242      *
 243      * @param  attributeSet  Underlying print request attribute set.
 244      *
 245      * @return  Unmodifiable view of {@code attributeSet}.
 246      *
 247      * @exception  NullPointerException
 248      *     Thrown if {@code attributeSet} is null.
 249      */
 250     public static PrintRequestAttributeSet
 251         unmodifiableView(PrintRequestAttributeSet attributeSet) {
 252         if (attributeSet == null) {
 253             throw new NullPointerException();
 254         }
 255         return new UnmodifiablePrintRequestAttributeSet(attributeSet);
 256     }
 257 
 258     /**
 259      * Creates an unmodifiable view of the given print job attribute set.
 260      *
 261      * @param  attributeSet  Underlying print job attribute set.
 262      *
 263      * @return  Unmodifiable view of {@code attributeSet}.
 264      *
 265      * @exception  NullPointerException
 266      *     Thrown if {@code attributeSet} is null.
 267      */
 268     public static PrintJobAttributeSet
 269         unmodifiableView(PrintJobAttributeSet attributeSet) {
 270         if (attributeSet == null) {
 271             throw new NullPointerException();
 272         }
 273         return new UnmodifiablePrintJobAttributeSet(attributeSet);
 274     }
 275 
 276     /**
 277      * Creates an unmodifiable view of the given print service attribute set.
 278      *
 279      * @param  attributeSet  Underlying print service attribute set.
 280      *
 281      * @return  Unmodifiable view of {@code attributeSet}.
 282      *
 283      * @exception  NullPointerException
 284      *     Thrown if {@code attributeSet} is null.
 285      */
 286     public static PrintServiceAttributeSet
 287         unmodifiableView(PrintServiceAttributeSet attributeSet) {
 288         if (attributeSet == null) {
 289             throw new NullPointerException();
 290         }
 291         return new UnmodifiablePrintServiceAttributeSet (attributeSet);
 292     }
 293 
 294     /**


 295       * @serial include
 296       */
 297     private static class SynchronizedAttributeSet
 298                         implements AttributeSet, Serializable {




 299         private static final long serialVersionUID = 8365731020128564925L;
 300 



 301         private AttributeSet attrset;
 302 





 303         public SynchronizedAttributeSet(AttributeSet attributeSet) {
 304             attrset = attributeSet;
 305         }
 306 
 307         public synchronized Attribute get(Class<?> category) {
 308             return attrset.get(category);
 309         }
 310 
 311         public synchronized boolean add(Attribute attribute) {
 312             return attrset.add(attribute);
 313         }
 314 
 315         public synchronized boolean remove(Class<?> category) {
 316             return attrset.remove(category);
 317         }
 318 
 319         public synchronized boolean remove(Attribute attribute) {
 320             return attrset.remove(attribute);
 321         }
 322 


 341         }
 342 
 343         public synchronized void clear() {
 344             attrset.clear();
 345         }
 346 
 347         public synchronized boolean isEmpty() {
 348             return attrset.isEmpty();
 349         }
 350 
 351         public synchronized boolean equals(Object o) {
 352             return attrset.equals (o);
 353         }
 354 
 355         public synchronized int hashCode() {
 356             return attrset.hashCode();
 357         }
 358     }
 359 
 360     /**


 361       * @serial include
 362       */
 363     private static class SynchronizedDocAttributeSet
 364         extends SynchronizedAttributeSet
 365         implements DocAttributeSet, Serializable {




 366         private static final long serialVersionUID = 6455869095246629354L;
 367 





 368         public SynchronizedDocAttributeSet(DocAttributeSet attributeSet) {
 369             super(attributeSet);
 370         }
 371     }
 372 
 373     /**


 374       * @serial include
 375       */
 376     private static class SynchronizedPrintRequestAttributeSet
 377         extends SynchronizedAttributeSet
 378         implements PrintRequestAttributeSet, Serializable {




 379         private static final long serialVersionUID = 5671237023971169027L;
 380 





 381         public SynchronizedPrintRequestAttributeSet
 382             (PrintRequestAttributeSet attributeSet) {
 383             super(attributeSet);
 384         }
 385     }
 386 
 387     /**


 388       * @serial include
 389       */
 390     private static class SynchronizedPrintJobAttributeSet
 391         extends SynchronizedAttributeSet
 392         implements PrintJobAttributeSet, Serializable {




 393         private static final long serialVersionUID = 2117188707856965749L;
 394 





 395         public SynchronizedPrintJobAttributeSet
 396             (PrintJobAttributeSet attributeSet) {
 397             super(attributeSet);
 398         }
 399     }
 400 
 401     /**


 402       * @serial include
 403       */
 404     private static class SynchronizedPrintServiceAttributeSet
 405         extends SynchronizedAttributeSet
 406         implements PrintServiceAttributeSet, Serializable {




 407         private static final long serialVersionUID = -2830705374001675073L;
 408 





 409         public SynchronizedPrintServiceAttributeSet
 410             (PrintServiceAttributeSet attributeSet) {
 411             super(attributeSet);
 412         }
 413     }
 414 
 415     /**
 416      * Creates a synchronized view of the given attribute set.
 417      *
 418      * @param  attributeSet  Underlying attribute set.
 419      *
 420      * @return  Synchronized view of {@code attributeSet}.
 421      *
 422      * @exception  NullPointerException
 423      *     Thrown if {@code attributeSet} is null.
 424      */
 425     public static AttributeSet synchronizedView
 426         (AttributeSet attributeSet) {
 427         if (attributeSet == null) {
 428             throw new NullPointerException();
 429         }
 430         return new SynchronizedAttributeSet(attributeSet);
 431     }
 432 
 433     /**
 434      * Creates a synchronized view of the given doc attribute set.
 435      *
 436      * @param  attributeSet  Underlying doc attribute set.
 437      *
 438      * @return  Synchronized view of {@code attributeSet}.
 439      *
 440      * @exception  NullPointerException
 441      *     Thrown if {@code attributeSet} is null.
 442      */
 443     public static DocAttributeSet
 444         synchronizedView(DocAttributeSet attributeSet) {
 445         if (attributeSet == null) {
 446             throw new NullPointerException();
 447         }
 448         return new SynchronizedDocAttributeSet(attributeSet);
 449     }
 450 
 451     /**
 452      * Creates a synchronized view of the given print request attribute set.
 453      *
 454      * @param  attributeSet  Underlying print request attribute set.
 455      *
 456      * @return  Synchronized view of {@code attributeSet}.
 457      *
 458      * @exception  NullPointerException
 459      *     Thrown if {@code attributeSet} is null.
 460      */
 461     public static PrintRequestAttributeSet
 462         synchronizedView(PrintRequestAttributeSet attributeSet) {
 463         if (attributeSet == null) {
 464             throw new NullPointerException();
 465         }
 466         return new SynchronizedPrintRequestAttributeSet(attributeSet);
 467     }
 468 
 469     /**
 470      * Creates a synchronized view of the given print job attribute set.
 471      *
 472      * @param  attributeSet  Underlying print job attribute set.
 473      *
 474      * @return  Synchronized view of {@code attributeSet}.
 475      *
 476      * @exception  NullPointerException
 477      *     Thrown if {@code attributeSet} is null.
 478      */
 479     public static PrintJobAttributeSet
 480         synchronizedView(PrintJobAttributeSet attributeSet) {
 481         if (attributeSet == null) {
 482             throw new NullPointerException();
 483         }
 484         return new SynchronizedPrintJobAttributeSet(attributeSet);
 485     }
 486 
 487     /**
 488      * Creates a synchronized view of the given print service attribute set.
 489      *
 490      * @param  attributeSet  Underlying print service attribute set.
 491      *
 492      * @return  Synchronized view of {@code attributeSet}.
 493      */
 494     public static PrintServiceAttributeSet
 495         synchronizedView(PrintServiceAttributeSet attributeSet) {
 496         if (attributeSet == null) {
 497             throw new NullPointerException();
 498         }
 499         return new SynchronizedPrintServiceAttributeSet(attributeSet);
 500     }
 501 
 502 
 503     /**
 504      * Verify that the given object is a {@link java.lang.Class Class} that
 505      * implements the given interface, which is assumed to be interface {@link
 506      * Attribute Attribute} or a subinterface thereof.
 507      *
 508      * @param  object     Object to test.
 509      * @param  interfaceName  Interface the object must implement.
 510      *
 511      * @return  If {@code object} is a {@link java.lang.Class Class}
 512      *          that implements {@code interfaceName},
 513      *          {@code object} is returned downcast to type {@link
 514      *          java.lang.Class Class}; otherwise an exception is thrown.
 515      *
 516      * @exception  NullPointerException
 517      *     (unchecked exception) Thrown if {@code object} is null.
 518      * @exception  ClassCastException
 519      *     (unchecked exception) Thrown if {@code object} is not a
 520      *     {@link java.lang.Class Class} that implements
 521      *     {@code interfaceName}.
 522      */
 523     public static Class<?>
 524         verifyAttributeCategory(Object object, Class<?> interfaceName) {
 525 
 526         Class<?> result = (Class<?>) object;
 527         if (interfaceName.isAssignableFrom (result)) {
 528             return result;
 529         }
 530         else {
 531             throw new ClassCastException();
 532         }
 533     }
 534 
 535     /**
 536      * Verify that the given object is an instance of the given interface, which
 537      * is assumed to be interface {@link Attribute Attribute} or a subinterface
 538      * thereof.
 539      *
 540      * @param  object     Object to test.
 541      * @param  interfaceName  Interface of which the object must be an instance.
 542      *
 543      * @return  If {@code object} is an instance of
 544      *          {@code interfaceName}, {@code object} is returned
 545      *          downcast to type {@link Attribute Attribute}; otherwise an
 546      *          exception is thrown.
 547      *
 548      * @exception  NullPointerException
 549      *     (unchecked exception) Thrown if {@code object} is null.
 550      * @exception  ClassCastException
 551      *     (unchecked exception) Thrown if {@code object} is not an
 552      *     instance of {@code interfaceName}.
 553      */
 554     public static Attribute
 555         verifyAttributeValue(Object object, Class<?> interfaceName) {
 556 
 557         if (object == null) {
 558             throw new NullPointerException();
 559         }
 560         else if (interfaceName.isInstance (object)) {
 561             return (Attribute) object;
 562         } else {
 563             throw new ClassCastException();
 564         }
 565     }
 566 
 567     /**
 568      * Verify that the given attribute category object is equal to the
 569      * category of the given attribute value object. If so, this method
 570      * returns doing nothing. If not, this method throws an exception.
 571      *
 572      * @param  category   Attribute category to test.
 573      * @param  attribute  Attribute value to test.
 574      *
 575      * @exception  NullPointerException
 576      *     (unchecked exception) Thrown if the {@code category} is
 577      *     null or if the {@code attribute} is null.
 578      * @exception  IllegalArgumentException
 579      *     (unchecked exception) Thrown if the {@code category} is not
 580      *     equal to the category of the {@code attribute}.
 581      */
 582     public static void
 583         verifyCategoryForValue(Class<?> category, Attribute attribute) {
 584 
 585         if (!category.equals (attribute.getCategory())) {
 586             throw new IllegalArgumentException();
 587         }
 588     }
 589 }
   1 /*
   2  * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 

  26 package javax.print.attribute;
  27 
  28 import java.io.Serializable;
  29 
  30 /**
  31  * Class {@code AttributeSetUtilities} provides static methods for manipulating
  32  * {@code AttributeSets}.
  33  * <ul>
  34  *   <li>Methods for creating unmodifiable and synchronized views of attribute
  35  *   sets.
  36  *   <li>operations useful for building implementations of interface
  37  *   {@link AttributeSet AttributeSet}
  38  * </ul>
  39  * An <b>unmodifiable view</b> <i>U</i> of an {@code AttributeSet} <i>S</i>
  40  * provides a client with "read-only" access to <i>S</i>. Query operations on
  41  * <i>U</i> "read through" to <i>S</i>; thus, changes in <i>S</i> are reflected
  42  * in <i>U</i>. However, any attempt to modify <i>U</i>, results in an
  43  * {@code UnmodifiableSetException}. The unmodifiable view object <i>U</i> will
  44  * be serializable if the attribute set object <i>S</i> is serializable.
  45  * <p>
  46  * A <b>synchronized view</b> <i>V</i> of an attribute set <i>S</i> provides a
  47  * client with synchronized (multiple thread safe) access to <i>S</i>. Each
  48  * operation of <i>V</i> is synchronized using <i>V</i> itself as the lock
  49  * object and then merely invokes the corresponding operation of <i>S</i>. In
  50  * order to guarantee mutually exclusive access, it is critical that all access
  51  * to <i>S</i> is accomplished through <i>V</i>. The synchronized view object
  52  * <i>V</i> will be serializable if the attribute set object <i>S</i> is
  53  * serializable.
  54  * <p>
  55  * As mentioned in the package description of {@code javax.print}, a
  56  * {@code null} reference parameter to methods is incorrect unless explicitly
  57  * documented on the method as having a meaningful interpretation. Usage to the
  58  * contrary is incorrect coding and may result in a run time exception either
  59  * immediately or at some later time. {@code IllegalArgumentException} and
  60  * {@code NullPointerException} are examples of typical and acceptable run time
  61  * exceptions for such cases.


  62  *
  63  * @author Alan Kaminsky
  64  */
  65 public final class AttributeSetUtilities {
  66 
  67     /**
  68      * Suppress default constructor, ensuring non-instantiability.
  69      */
  70     private AttributeSetUtilities() {
  71     }
  72 
  73     /**
  74      * Unmodifiable view of {@code AttributeSet}.
  75      *
  76      * @serial include
  77      */
  78     private static class UnmodifiableAttributeSet
  79         implements AttributeSet, Serializable {
  80 
  81         /**
  82          * Use serialVersionUID from JDK 1.4 for interoperability.
  83          */
  84         private static final long serialVersionUID = -6131802583863447813L;
  85 
  86         /**
  87          * The attribute set.
  88          */
  89         private AttributeSet attrset;
  90 
  91         /**
  92          * Constructs unmodifiable view of the underlying attribute set.
  93          *
  94          * @param  attributeSet the attribute set
  95          */
  96         public UnmodifiableAttributeSet(AttributeSet attributeSet) {
  97 
  98             attrset = attributeSet;
  99         }
 100 
 101         public Attribute get(Class<?> key) {
 102             return attrset.get(key);
 103         }
 104 
 105         public boolean add(Attribute attribute) {
 106             throw new UnmodifiableSetException();
 107         }
 108 
 109         public synchronized boolean remove(Class<?> category) {
 110             throw new UnmodifiableSetException();
 111         }
 112 
 113         public boolean remove(Attribute attribute) {
 114             throw new UnmodifiableSetException();


 132 
 133         public Attribute[] toArray() {
 134             return attrset.toArray();
 135         }
 136 
 137         public void clear() {
 138             throw new UnmodifiableSetException();
 139         }
 140 
 141         public boolean isEmpty() {
 142             return attrset.isEmpty();
 143         }
 144 
 145         public boolean equals(Object o) {
 146             return attrset.equals (o);
 147         }
 148 
 149         public int hashCode() {
 150             return attrset.hashCode();
 151         }

 152     }
 153 
 154     /**
 155      * Unmodifiable view of {@code DocAttributeSet}.
 156      *
 157      * @serial include
 158      */
 159     private static class UnmodifiableDocAttributeSet
 160         extends UnmodifiableAttributeSet
 161         implements DocAttributeSet, Serializable {
 162 
 163         /**
 164          * Use serialVersionUID from JDK 1.4 for interoperability.
 165          */
 166         private static final long serialVersionUID = -6349408326066898956L;
 167 
 168         /**
 169          * Constructs a new unmodifiable doc attribute set.
 170          *
 171          * @param  attributeSet the doc attribute set
 172          */
 173         public UnmodifiableDocAttributeSet(DocAttributeSet attributeSet) {
 174 
 175             super (attributeSet);
 176         }
 177     }
 178 
 179     /**
 180      * Unmodifiable view of {@code PrintRequestAttributeSet}.
 181      *
 182      * @serial include
 183      */
 184     private static class UnmodifiablePrintRequestAttributeSet
 185         extends UnmodifiableAttributeSet
 186         implements PrintRequestAttributeSet, Serializable
 187     {
 188 
 189         /**
 190          * Use serialVersionUID from JDK 1.4 for interoperability.
 191          */
 192         private static final long serialVersionUID = 7799373532614825073L;
 193 
 194         /**
 195          * Constructs a new unmodifiable print request attribute set.
 196          *
 197          * @param  attributeSet the print request attribute set
 198          */
 199         public UnmodifiablePrintRequestAttributeSet
 200             (PrintRequestAttributeSet attributeSet) {
 201 
 202             super (attributeSet);
 203         }
 204     }
 205 
 206     /**
 207      * Unmodifiable view of {@code PrintJobAttributeSet}.
 208      *
 209      * @serial include
 210      */
 211     private static class UnmodifiablePrintJobAttributeSet
 212         extends UnmodifiableAttributeSet
 213         implements PrintJobAttributeSet, Serializable
 214     {
 215         /**
 216          * Use serialVersionUID from JDK 1.4 for interoperability.
 217          */
 218         private static final long serialVersionUID = -8002245296274522112L;
 219 
 220         /**
 221          * Constructs a new unmodifiable print job attribute set.
 222          *
 223          * @param  attributeSet the print job attribute set
 224          */
 225         public UnmodifiablePrintJobAttributeSet
 226             (PrintJobAttributeSet attributeSet) {
 227 
 228             super (attributeSet);
 229         }
 230     }
 231 
 232     /**
 233      * Unmodifiable view of {@code PrintServiceAttributeSet}.
 234      *
 235      * @serial include
 236      */
 237     private static class UnmodifiablePrintServiceAttributeSet
 238         extends UnmodifiableAttributeSet
 239         implements PrintServiceAttributeSet, Serializable
 240     {
 241         /**
 242          * Use serialVersionUID from JDK 1.4 for interoperability.
 243          */
 244         private static final long serialVersionUID = -7112165137107826819L;
 245 
 246         /**
 247          * Constructs a new unmodifiable print service attribute set.
 248          *
 249          * @param  attributeSet the print service attribute set
 250          */
 251         public UnmodifiablePrintServiceAttributeSet
 252             (PrintServiceAttributeSet attributeSet) {
 253 
 254             super (attributeSet);
 255         }
 256     }
 257 
 258     /**
 259      * Creates an unmodifiable view of the given attribute set.
 260      *
 261      * @param  attributeSet underlying attribute set
 262      * @return unmodifiable view of {@code attributeSet}
 263      * @throws NullPointerException if {@code attributeSet} is {@code null}



 264      */
 265     public static AttributeSet unmodifiableView(AttributeSet attributeSet) {
 266         if (attributeSet == null) {
 267             throw new NullPointerException();
 268         }
 269 
 270         return new UnmodifiableAttributeSet(attributeSet);
 271     }
 272 
 273     /**
 274      * Creates an unmodifiable view of the given doc attribute set.
 275      *
 276      * @param  attributeSet underlying doc attribute set
 277      * @return unmodifiable view of {@code attributeSet}
 278      * @throws NullPointerException if {@code attributeSet} is {@code null}



 279      */
 280     public static DocAttributeSet unmodifiableView
 281         (DocAttributeSet attributeSet) {
 282         if (attributeSet == null) {
 283             throw new NullPointerException();
 284         }
 285         return new UnmodifiableDocAttributeSet(attributeSet);
 286     }
 287 
 288     /**
 289      * Creates an unmodifiable view of the given print request attribute set.
 290      *
 291      * @param  attributeSet underlying print request attribute set
 292      * @return unmodifiable view of {@code attributeSet}
 293      * @throws NullPointerException if {@code attributeSet} is {@code null}



 294      */
 295     public static PrintRequestAttributeSet
 296         unmodifiableView(PrintRequestAttributeSet attributeSet) {
 297         if (attributeSet == null) {
 298             throw new NullPointerException();
 299         }
 300         return new UnmodifiablePrintRequestAttributeSet(attributeSet);
 301     }
 302 
 303     /**
 304      * Creates an unmodifiable view of the given print job attribute set.
 305      *
 306      * @param  attributeSet underlying print job attribute set
 307      * @return unmodifiable view of {@code attributeSet}
 308      * @throws NullPointerException if {@code attributeSet} is {@code null}



 309      */
 310     public static PrintJobAttributeSet
 311         unmodifiableView(PrintJobAttributeSet attributeSet) {
 312         if (attributeSet == null) {
 313             throw new NullPointerException();
 314         }
 315         return new UnmodifiablePrintJobAttributeSet(attributeSet);
 316     }
 317 
 318     /**
 319      * Creates an unmodifiable view of the given print service attribute set.
 320      *
 321      * @param  attributeSet underlying print service attribute set
 322      * @return unmodifiable view of {@code attributeSet}
 323      * @throws NullPointerException if {@code attributeSet} is {@code null}



 324      */
 325     public static PrintServiceAttributeSet
 326         unmodifiableView(PrintServiceAttributeSet attributeSet) {
 327         if (attributeSet == null) {
 328             throw new NullPointerException();
 329         }
 330         return new UnmodifiablePrintServiceAttributeSet (attributeSet);
 331     }
 332 
 333     /**
 334      * Synchronized view of {@code AttributeSet}.
 335      *
 336      * @serial include
 337      */
 338     private static class SynchronizedAttributeSet
 339                         implements AttributeSet, Serializable {
 340 
 341         /**
 342          * Use serialVersionUID from JDK 1.4 for interoperability.
 343          */
 344         private static final long serialVersionUID = 8365731020128564925L;
 345 
 346         /**
 347          * The attribute set.
 348          */
 349         private AttributeSet attrset;
 350 
 351         /**
 352          * Constructs a new synchronized attribute set.
 353          *
 354          * @param  attributeSet the attribute set
 355          */
 356         public SynchronizedAttributeSet(AttributeSet attributeSet) {
 357             attrset = attributeSet;
 358         }
 359 
 360         public synchronized Attribute get(Class<?> category) {
 361             return attrset.get(category);
 362         }
 363 
 364         public synchronized boolean add(Attribute attribute) {
 365             return attrset.add(attribute);
 366         }
 367 
 368         public synchronized boolean remove(Class<?> category) {
 369             return attrset.remove(category);
 370         }
 371 
 372         public synchronized boolean remove(Attribute attribute) {
 373             return attrset.remove(attribute);
 374         }
 375 


 394         }
 395 
 396         public synchronized void clear() {
 397             attrset.clear();
 398         }
 399 
 400         public synchronized boolean isEmpty() {
 401             return attrset.isEmpty();
 402         }
 403 
 404         public synchronized boolean equals(Object o) {
 405             return attrset.equals (o);
 406         }
 407 
 408         public synchronized int hashCode() {
 409             return attrset.hashCode();
 410         }
 411     }
 412 
 413     /**
 414      * Synchronized view of {@code DocAttributeSet}.
 415      *
 416      * @serial include
 417      */
 418     private static class SynchronizedDocAttributeSet
 419         extends SynchronizedAttributeSet
 420         implements DocAttributeSet, Serializable {
 421 
 422         /**
 423          * Use serialVersionUID from JDK 1.4 for interoperability.
 424          */
 425         private static final long serialVersionUID = 6455869095246629354L;
 426 
 427         /**
 428          * Constructs a new synchronized doc attribute set.
 429          *
 430          * @param  attributeSet the doc attribute set
 431          */
 432         public SynchronizedDocAttributeSet(DocAttributeSet attributeSet) {
 433             super(attributeSet);
 434         }
 435     }
 436 
 437     /**
 438      * Synchronized view of {@code PrintRequestAttributeSet}.
 439      *
 440      * @serial include
 441      */
 442     private static class SynchronizedPrintRequestAttributeSet
 443         extends SynchronizedAttributeSet
 444         implements PrintRequestAttributeSet, Serializable {
 445 
 446         /**
 447          * Use serialVersionUID from JDK 1.4 for interoperability.
 448          */
 449         private static final long serialVersionUID = 5671237023971169027L;
 450 
 451         /**
 452          * Constructs a new synchronized print request attribute set.
 453          *
 454          * @param  attributeSet the print request attribute set
 455          */
 456         public SynchronizedPrintRequestAttributeSet
 457             (PrintRequestAttributeSet attributeSet) {
 458             super(attributeSet);
 459         }
 460     }
 461 
 462     /**
 463      * Synchronized view of {@code PrintJobAttributeSet}.
 464      *
 465      * @serial include
 466      */
 467     private static class SynchronizedPrintJobAttributeSet
 468         extends SynchronizedAttributeSet
 469         implements PrintJobAttributeSet, Serializable {
 470 
 471         /**
 472          * Use serialVersionUID from JDK 1.4 for interoperability.
 473          */
 474         private static final long serialVersionUID = 2117188707856965749L;
 475 
 476         /**
 477          * Constructs a new synchronized print job attribute set.
 478          *
 479          * @param  attributeSet the print job attribute set
 480          */
 481         public SynchronizedPrintJobAttributeSet
 482             (PrintJobAttributeSet attributeSet) {
 483             super(attributeSet);
 484         }
 485     }
 486 
 487     /**
 488      * Synchronized view of {@code PrintServiceAttributeSet}.
 489      *
 490      * @serial include
 491      */
 492     private static class SynchronizedPrintServiceAttributeSet
 493         extends SynchronizedAttributeSet
 494         implements PrintServiceAttributeSet, Serializable {
 495 
 496         /**
 497          * Use serialVersionUID from JDK 1.4 for interoperability.
 498          */
 499         private static final long serialVersionUID = -2830705374001675073L;
 500 
 501         /**
 502          * Constructs a new synchronized print service attribute set.
 503          *
 504          * @param  attributeSet the print service attribute set
 505          */
 506         public SynchronizedPrintServiceAttributeSet
 507             (PrintServiceAttributeSet attributeSet) {
 508             super(attributeSet);
 509         }
 510     }
 511 
 512     /**
 513      * Creates a synchronized view of the given attribute set.
 514      *
 515      * @param  attributeSet underlying attribute set
 516      * @return synchronized view of {@code attributeSet}
 517      * @throws NullPointerException if {@code attributeSet} is {@code null}



 518      */
 519     public static AttributeSet synchronizedView
 520         (AttributeSet attributeSet) {
 521         if (attributeSet == null) {
 522             throw new NullPointerException();
 523         }
 524         return new SynchronizedAttributeSet(attributeSet);
 525     }
 526 
 527     /**
 528      * Creates a synchronized view of the given doc attribute set.
 529      *
 530      * @param  attributeSet underlying doc attribute set
 531      * @return synchronized view of {@code attributeSet}
 532      * @throws NullPointerException if {@code attributeSet} is {@code null}



 533      */
 534     public static DocAttributeSet
 535         synchronizedView(DocAttributeSet attributeSet) {
 536         if (attributeSet == null) {
 537             throw new NullPointerException();
 538         }
 539         return new SynchronizedDocAttributeSet(attributeSet);
 540     }
 541 
 542     /**
 543      * Creates a synchronized view of the given print request attribute set.
 544      *
 545      * @param  attributeSet underlying print request attribute set
 546      * @return synchronized view of {@code attributeSet}
 547      * @throws NullPointerException if {@code attributeSet} is {@code null}



 548      */
 549     public static PrintRequestAttributeSet
 550         synchronizedView(PrintRequestAttributeSet attributeSet) {
 551         if (attributeSet == null) {
 552             throw new NullPointerException();
 553         }
 554         return new SynchronizedPrintRequestAttributeSet(attributeSet);
 555     }
 556 
 557     /**
 558      * Creates a synchronized view of the given print job attribute set.
 559      *
 560      * @param  attributeSet underlying print job attribute set
 561      * @return synchronized view of {@code attributeSet}
 562      * @throws NullPointerException if {@code attributeSet} is {@code null}



 563      */
 564     public static PrintJobAttributeSet
 565         synchronizedView(PrintJobAttributeSet attributeSet) {
 566         if (attributeSet == null) {
 567             throw new NullPointerException();
 568         }
 569         return new SynchronizedPrintJobAttributeSet(attributeSet);
 570     }
 571 
 572     /**
 573      * Creates a synchronized view of the given print service attribute set.
 574      *
 575      * @param  attributeSet underlying print service attribute set
 576      * @return synchronized view of {@code attributeSet}
 577      * @throws NullPointerException if {@code attributeSet} is {@code null}
 578      */
 579     public static PrintServiceAttributeSet
 580         synchronizedView(PrintServiceAttributeSet attributeSet) {
 581         if (attributeSet == null) {
 582             throw new NullPointerException();
 583         }
 584         return new SynchronizedPrintServiceAttributeSet(attributeSet);
 585     }
 586 

 587     /**
 588      * Verify that the given object is a {@link Class Class} that implements the
 589      * given interface, which is assumed to be interface
 590      * {@link Attribute Attribute} or a subinterface thereof.
 591      *
 592      * @param  object {@code Object} to test
 593      * @param  interfaceName interface the object must implement
 594      * @return if {@code object} is a {@link Class Class} that implements
 595      *         {@code interfaceName}, {@code object} is returned downcast to
 596      *         type {@link Class Class}; otherwise an exception is thrown
 597      * @throws NullPointerException if {@code object} is {@code null}
 598      * @throws ClassCastException if {@code object} is not a
 599      *         {@link Class Class} that implements {@code interfaceName}






 600      */
 601     public static Class<?>
 602         verifyAttributeCategory(Object object, Class<?> interfaceName) {
 603 
 604         Class<?> result = (Class<?>) object;
 605         if (interfaceName.isAssignableFrom (result)) {
 606             return result;
 607         }
 608         else {
 609             throw new ClassCastException();
 610         }
 611     }
 612 
 613     /**
 614      * Verify that the given object is an instance of the given interface, which
 615      * is assumed to be interface {@link Attribute Attribute} or a subinterface
 616      * thereof.
 617      *
 618      * @param  object {@code Object} to test
 619      * @param  interfaceName interface of which the object must be an instance
 620      * @return if {@code object} is an instance of {@code interfaceName},
 621      *         {@code object} is returned downcast to type
 622      *         {@link Attribute Attribute}; otherwise an exception is thrown
 623      * @throws NullPointerException if {@code object} is {@code null}
 624      * @throws ClassCastException if {@code object} is not an instance of
 625      *         {@code interfaceName}





 626      */
 627     public static Attribute
 628         verifyAttributeValue(Object object, Class<?> interfaceName) {
 629 
 630         if (object == null) {
 631             throw new NullPointerException();
 632         }
 633         else if (interfaceName.isInstance (object)) {
 634             return (Attribute) object;
 635         } else {
 636             throw new ClassCastException();
 637         }
 638     }
 639 
 640     /**
 641      * Verify that the given attribute category object is equal to the category
 642      * of the given attribute value object. If so, this method returns doing
 643      * nothing. If not, this method throws an exception.
 644      *
 645      * @param  category attribute category to test
 646      * @param  attribute attribute value to test
 647      * @throws NullPointerException if the {@code category} or {@code attribute}
 648      *         are {@code null}
 649      * @throws IllegalArgumentException if the {@code category} is not equal to
 650      *         the category of the {@code attribute}



 651      */
 652     public static void
 653         verifyCategoryForValue(Class<?> category, Attribute attribute) {
 654 
 655         if (!category.equals (attribute.getCategory())) {
 656             throw new IllegalArgumentException();
 657         }
 658     }
 659 }
< prev index next >