Source for javax.print.attribute.PrintJobAttributeSet

   1: /* PrintJobAttributeSet.java -- 
   2:    Copyright (C) 2003, 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.print.attribute;
  39: 
  40: /**
  41:  * <code>PrintJobAttributeSet</code> specifies an attribute set which only
  42:  * allows printing attributes of type 
  43:  * {@link javax.print.attribute.PrintJobAttribute}.
  44:  * <p>
  45:  * The methods {@link #add(Attribute)} and {@link #addAll(AttributeSet)} are
  46:  * respecified in this interface to indicate that only 
  47:  * <code>PrintJobAttribute</code> instances are allowed in this set.
  48:  * </p>
  49:  * 
  50:  * @author Michael Koch (konqueror@gmx.de)
  51:  */
  52: public interface PrintJobAttributeSet extends AttributeSet
  53: {
  54:   /**
  55:    * Adds the specified attribute value to this attribute set 
  56:    * if it is not already present.
  57:    * 
  58:    * This operation removes any existing attribute of the same category 
  59:    * before adding the given attribute. 
  60:    * 
  61:    * @param attribute the attribute to add.
  62:    * @return <code>true</code> if the set is changed, false otherwise.
  63:    * @throws ClassCastException if attribute is not of type 
  64:    * <code>PrintJobAttribute</code>.
  65:    * @throws NullPointerException if the attribute is <code>null</code>.
  66:    * @throws UnmodifiableSetException if the set does not support modification.
  67:    */
  68:   boolean add (Attribute attribute);
  69: 
  70:   /**
  71:    * Adds all of the elements in the specified set to this attribute set.
  72:    * 
  73:    * @param attributes the set of attributes to add.
  74:    * @return <code>true</code> if the set is changed, false otherwise.
  75:    * @throws ClassCastException if one of the attributes is not of type 
  76:    * <code>PrintJobAttribute</code>.
  77:    * @throws UnmodifiableSetException if the set does not support modification.
  78:    * 
  79:    * @see #add(Attribute)
  80:    */
  81:   boolean addAll (AttributeSet attributes);
  82: }