JobStateReasons.java 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. /* JobStateReasons.java --
  2. Copyright (C) 2004, 2005 Free Software Foundation, Inc.
  3. This file is part of GNU Classpath.
  4. GNU Classpath is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 2, or (at your option)
  7. any later version.
  8. GNU Classpath is distributed in the hope that it will be useful, but
  9. WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with GNU Classpath; see the file COPYING. If not, write to the
  14. Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  15. 02110-1301 USA.
  16. Linking this library statically or dynamically with other modules is
  17. making a combined work based on this library. Thus, the terms and
  18. conditions of the GNU General Public License cover the whole
  19. combination.
  20. As a special exception, the copyright holders of this library give you
  21. permission to link this library with independent modules to produce an
  22. executable, regardless of the license terms of these independent
  23. modules, and to copy and distribute the resulting executable under
  24. terms of your choice, provided that you also meet, for each linked
  25. independent module, the terms and conditions of the license of that
  26. module. An independent module is a module which is not derived from
  27. or based on this library. If you modify this library, you may extend
  28. this exception to your version of the library, but you are not
  29. obligated to do so. If you do not wish to do so, delete this
  30. exception statement from your version. */
  31. package javax.print.attribute.standard;
  32. import java.util.Collection;
  33. import java.util.HashSet;
  34. import javax.print.attribute.Attribute;
  35. import javax.print.attribute.PrintJobAttribute;
  36. /**
  37. * The <code>JobStateReasons</code> attribute provides the set of
  38. * additional informations available about the current state of a print job.
  39. * <p>
  40. * <b>IPP Compatibility:</b> JobStateReasons is an IPP 1.1 attribute.
  41. * </p>
  42. * @see javax.print.attribute.standard.JobState
  43. * @see javax.print.attribute.standard.JobStateReason
  44. *
  45. * @author Michael Koch (konqueror@gmx.de)
  46. * @author Wolfgang Baer (WBaer@gmx.de)
  47. */
  48. public final class JobStateReasons extends HashSet<JobStateReason>
  49. implements PrintJobAttribute
  50. {
  51. private static final long serialVersionUID = 8849088261264331812L;
  52. /**
  53. * Constructs an empty <code>JobStateReasons</code> attribute.
  54. */
  55. public JobStateReasons()
  56. {
  57. super();
  58. }
  59. /**
  60. * Constructs an empty <code>JobStateReasons</code> attribute
  61. * with the given initial capacity and load factor.
  62. *
  63. * @param initialCapacity the intial capacity.
  64. * @param loadFactor the load factor of the underlying HashSet.
  65. *
  66. * @throws IllegalArgumentException if initialCapacity &lt; 0
  67. * @throws IllegalArgumentException if initialCapacity or loadFactor &lt; 0
  68. */
  69. public JobStateReasons(int initialCapacity, float loadFactor)
  70. {
  71. super(initialCapacity, loadFactor);
  72. }
  73. /**
  74. * Constructs an empty <code>JobStateReasons</code> attribute
  75. * with the given initial capacity and the default load factor.
  76. *
  77. * @param initialCapacity the intial capacity.
  78. *
  79. * @throws IllegalArgumentException if initialCapacity &lt; 0
  80. */
  81. public JobStateReasons(int initialCapacity)
  82. {
  83. super(initialCapacity);
  84. }
  85. /**
  86. * Constructs a <code>JobStateReasons</code> attribute
  87. * with the content of the given collection.
  88. *
  89. * @param collection the collection for the initial values.
  90. *
  91. * @throws NullPointerException if collection or any value is
  92. * <code>null</code>.
  93. * @throws ClassCastException if values of collection are not of type
  94. * <code>JobStateReason</code>.
  95. */
  96. public JobStateReasons(Collection<JobStateReason> collection)
  97. {
  98. super(collection.size(), 0.75f);
  99. for (JobStateReason reason : collection)
  100. add(reason);
  101. }
  102. /**
  103. * Adds the given job state reason object to the set.
  104. *
  105. * @param o the reason of type <code>JobStateReason</code>.
  106. * @return <code>true</code> if set changed, <code>false</code> otherwise.
  107. *
  108. * @throws NullPointerException if given object is <code>null</code>.
  109. * @throws ClassCastException if given object is not an instance of
  110. * <code>JobStateReason</code>.
  111. */
  112. public boolean add(JobStateReason o)
  113. {
  114. if (o == null)
  115. throw new NullPointerException("reason is null");
  116. return super.add(o);
  117. }
  118. /**
  119. * Returns category of this class.
  120. *
  121. * @return The class <code>JobStateReasons</code> itself.
  122. */
  123. public Class< ? extends Attribute> getCategory()
  124. {
  125. return JobStateReasons.class;
  126. }
  127. /**
  128. * Returns the name of this attribute.
  129. *
  130. * @return The name "job-state-reasons".
  131. */
  132. public String getName()
  133. {
  134. return "job-state-reasons";
  135. }
  136. }