001    /* JobStateReasons.java --
002       Copyright (C) 2004, 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.print.attribute.standard;
040    
041    import java.util.Collection;
042    import java.util.HashSet;
043    import java.util.Iterator;
044    
045    import javax.print.attribute.Attribute;
046    import javax.print.attribute.PrintJobAttribute;
047    
048    /**
049     * The <code>JobStateReasons</code> attribute provides the set of 
050     * additional informations available about the current state of a print job. 
051     * <p>
052     * <b>IPP Compatibility:</b> JobStateReasons is an IPP 1.1 attribute.
053     * </p>
054     * @see javax.print.attribute.standard.JobState
055     * @see javax.print.attribute.standard.JobStateReason
056     * 
057     * @author Michael Koch (konqueror@gmx.de)
058     * @author Wolfgang Baer (WBaer@gmx.de)
059     */
060    public final class JobStateReasons extends HashSet<JobStateReason>
061      implements PrintJobAttribute
062    {
063      private static final long serialVersionUID = 8849088261264331812L;
064    
065      /**
066       * Constructs an empty <code>JobStateReasons</code> attribute.
067       */  
068      public JobStateReasons()
069      {
070        super();
071      }
072    
073      /**
074       * Constructs an empty <code>JobStateReasons</code> attribute
075       * with the given initial capacity and load factor.
076       * 
077       * @param initialCapacity the intial capacity.
078       * @param loadFactor the load factor of the underlying HashSet.
079       * 
080       * @throws IllegalArgumentException if initialCapacity &lt; 0
081       * @throws IllegalArgumentException if initialCapacity or loadFactor &lt; 0
082       */
083      public JobStateReasons(int initialCapacity, float loadFactor)
084      {
085        super(initialCapacity, loadFactor);
086      }
087    
088      /**
089       * Constructs an empty <code>JobStateReasons</code> attribute
090       * with the given initial capacity and the default load factor.
091       * 
092       * @param initialCapacity the intial capacity.
093       * 
094       * @throws IllegalArgumentException if initialCapacity &lt; 0
095       */
096      public JobStateReasons(int initialCapacity)
097      {
098        super(initialCapacity);
099      }
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    }