OSDN Git Service

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