Source for javax.print.attribute.standard.JobStateReasons

   1: /* JobStateReasons.java --
   2:    Copyright (C) 2004, 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: 
  39: package javax.print.attribute.standard;
  40: 
  41: import java.util.Collection;
  42: import java.util.HashSet;
  43: import java.util.Iterator;
  44: 
  45: import javax.print.attribute.Attribute;
  46: import javax.print.attribute.PrintJobAttribute;
  47: 
  48: /**
  49:  * The <code>JobStateReasons</code> attribute provides the set of 
  50:  * additional informations available about the current state of a print job. 
  51:  * <p>
  52:  * <b>IPP Compatibility:</b> JobStateReasons is an IPP 1.1 attribute.
  53:  * </p>
  54:  * @see javax.print.attribute.standard.JobState
  55:  * @see javax.print.attribute.standard.JobStateReason
  56:  * 
  57:  * @author Michael Koch (konqueror@gmx.de)
  58:  * @author Wolfgang Baer (WBaer@gmx.de)
  59:  */
  60: public final class JobStateReasons extends HashSet<JobStateReason>
  61:   implements PrintJobAttribute
  62: {
  63:   private static final long serialVersionUID = 8849088261264331812L;
  64: 
  65:   /**
  66:    * Constructs an empty <code>JobStateReasons</code> attribute.
  67:    */  
  68:   public JobStateReasons()
  69:   {
  70:     super();
  71:   }
  72: 
  73:   /**
  74:    * Constructs an empty <code>JobStateReasons</code> attribute
  75:    * with the given initial capacity and load factor.
  76:    * 
  77:    * @param initialCapacity the intial capacity.
  78:    * @param loadFactor the load factor of the underlying HashSet.
  79:    * 
  80:    * @throws IllegalArgumentException if initialCapacity &lt; 0
  81:    * @throws IllegalArgumentException if initialCapacity or loadFactor &lt; 0
  82:    */
  83:   public JobStateReasons(int initialCapacity, float loadFactor)
  84:   {
  85:     super(initialCapacity, loadFactor);
  86:   }
  87: 
  88:   /**
  89:    * Constructs an empty <code>JobStateReasons</code> attribute
  90:    * with the given initial capacity and the default load factor.
  91:    * 
  92:    * @param initialCapacity the intial capacity.
  93:    * 
  94:    * @throws IllegalArgumentException if initialCapacity &lt; 0
  95:    */
  96:   public JobStateReasons(int initialCapacity)
  97:   {
  98:     super(initialCapacity);
  99:   }
 100: 
 101:   /**
 102:    * Constructs a <code>JobStateReasons</code> attribute
 103:    * with the content of the given collection.
 104:    * 
 105:    * @param collection the collection for the initial values.
 106:    * 
 107:    * @throws NullPointerException if collection or any value is 
 108:    * <code>null</code>.
 109:    * @throws ClassCastException if values of collection are not of type 
 110:    * <code>JobStateReason</code>.
 111:    */
 112:   public JobStateReasons(Collection<JobStateReason> collection)
 113:   {
 114:     super(collection.size(), 0.75f);
 115:     for (JobStateReason reason : collection)
 116:       add(reason);
 117:   }
 118: 
 119:   /**
 120:    * Adds the given job state reason object to the set.
 121:    * 
 122:    * @param o the reason of type <code>JobStateReason</code>.
 123:    * @return <code>true</code> if set changed, <code>false</code> otherwise.
 124:    * 
 125:    * @throws NullPointerException if given object is <code>null</code>.
 126:    * @throws ClassCastException if given object is not an instance of
 127:    * <code>JobStateReason</code>.
 128:    */
 129:   public boolean add(JobStateReason o)
 130:   {
 131:     if (o == null)
 132:       throw new NullPointerException("reason is null");  
 133:     
 134:     return add(o);
 135:   }
 136:   
 137:   /**
 138:    * Returns category of this class.
 139:    *
 140:    * @return The class <code>JobStateReasons</code> itself.
 141:    */
 142:   public Class< ? extends Attribute> getCategory()
 143:   {
 144:     return JobStateReasons.class;
 145:   }
 146: 
 147:   /**
 148:    * Returns the name of this attribute.
 149:    *
 150:    * @return The name "job-state-reasons".
 151:    */
 152:   public String getName()
 153:   {
 154:     return "job-state-reasons";
 155:   }
 156: }