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 javax.print.attribute.Attribute; 044 import javax.print.attribute.PrintJobAttribute; 045 046 /** 047 * The <code>JobStateReasons</code> attribute provides the set of 048 * additional informations available about the current state of a print job. 049 * <p> 050 * <b>IPP Compatibility:</b> JobStateReasons is an IPP 1.1 attribute. 051 * </p> 052 * @see javax.print.attribute.standard.JobState 053 * @see javax.print.attribute.standard.JobStateReason 054 * 055 * @author Michael Koch (konqueror@gmx.de) 056 * @author Wolfgang Baer (WBaer@gmx.de) 057 */ 058 public final class JobStateReasons extends HashSet<JobStateReason> 059 implements PrintJobAttribute 060 { 061 private static final long serialVersionUID = 8849088261264331812L; 062 063 /** 064 * Constructs an empty <code>JobStateReasons</code> attribute. 065 */ 066 public JobStateReasons() 067 { 068 super(); 069 } 070 071 /** 072 * Constructs an empty <code>JobStateReasons</code> attribute 073 * with the given initial capacity and load factor. 074 * 075 * @param initialCapacity the intial capacity. 076 * @param loadFactor the load factor of the underlying HashSet. 077 * 078 * @throws IllegalArgumentException if initialCapacity < 0 079 * @throws IllegalArgumentException if initialCapacity or loadFactor < 0 080 */ 081 public JobStateReasons(int initialCapacity, float loadFactor) 082 { 083 super(initialCapacity, loadFactor); 084 } 085 086 /** 087 * Constructs an empty <code>JobStateReasons</code> attribute 088 * with the given initial capacity and the default load factor. 089 * 090 * @param initialCapacity the intial capacity. 091 * 092 * @throws IllegalArgumentException if initialCapacity < 0 093 */ 094 public JobStateReasons(int initialCapacity) 095 { 096 super(initialCapacity); 097 } 098 099 /** 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 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 }