1 /* 2 * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 27 package javax.print.attribute; 28 29 /** 30 * Interface PrintServiceAttributeSet specifies the interface for a set of 31 * print job attributes, i.e. printing attributes that implement interface 32 * {@link 33 * PrintServiceAttribute PrintServiceAttribute}. In the Print Service API, 34 * the Print Service instance uses a PrintServiceAttributeSet to report the 35 * status of the print service. 36 * <P> 37 * A PrintServiceAttributeSet is just an {@link AttributeSet AttributeSet} 38 * whose constructors and mutating operations guarantee an additional 39 * invariant, 40 * namely that all attribute values in the PrintServiceAttributeSet must be 41 * instances of interface {@link PrintServiceAttribute PrintServiceAttribute}. 42 * The {@link #add(Attribute) add(Attribute)}, and 43 * {@link #addAll(AttributeSet) addAll(AttributeSet)} operations 44 * are respecified below to guarantee this additional invariant. 45 * 46 * @author Alan Kaminsky 47 */ 48 public interface PrintServiceAttributeSet extends AttributeSet { 49 50 51 52 /** 53 * Adds the specified attribute value to this attribute set if it is not 54 * already present, first removing any existing value in the same 55 * attribute category as the specified attribute value (optional 56 * operation). 57 * 58 * @param attribute Attribute value to be added to this attribute set. 59 * 60 * @return <tt>true</tt> if this attribute set changed as a result of 61 * the call, i.e., the given attribute value was not already a 62 * member of this attribute set. 63 * 64 * @throws UnmodifiableSetException 65 * (unchecked exception) Thrown if this attribute set does not 66 * support the <CODE>add()</CODE> operation. 67 * @throws ClassCastException 68 * (unchecked exception) Thrown if the <CODE>attribute</CODE> is 69 * not an instance of interface 70 * {@link PrintServiceAttribute PrintServiceAttribute}. 71 * @throws NullPointerException 72 * (unchecked exception) Thrown if the <CODE>attribute</CODE> is null. 73 */ 74 public boolean add(Attribute attribute); 75 76 /** 77 * Adds all of the elements in the specified set to this attribute. 78 * The outcome is the same as if the 79 * {@link #add(Attribute) add(Attribute)} 80 * operation had been applied to this attribute set successively with 81 * each element from the specified set. If none of the categories in the 82 * specified set are the same as any categories in this attribute set, 83 * the <tt>addAll()</tt> operation effectively modifies this attribute 84 * set so that its value is the <i>union</i> of the two sets. 85 * <P> 86 * The behavior of the <CODE>addAll()</CODE> operation is unspecified if 87 * the specified set is modified while the operation is in progress. 88 * <P> 89 * If the <CODE>addAll()</CODE> operation throws an exception, the effect 90 * on this attribute set's state is implementation dependent; elements 91 * from the specified set before the point of the exception may or 92 * may not have been added to this attribute set. 93 * 94 * @param attributes whose elements are to be added to this attribute 95 * set. 96 * 97 * @return <tt>true</tt> if this attribute set changed as a result of 98 * the call. 99 * 100 * @throws UnmodifiableSetException 101 * (Unchecked exception) Thrown if this attribute set does not 102 * support the <tt>addAll()</tt> method. 103 * @throws ClassCastException 104 * (Unchecked exception) Thrown if some element in the specified 105 * set is not an instance of interface {@link PrintServiceAttribute 106 * PrintServiceAttribute}. 107 * @throws NullPointerException 108 * (Unchecked exception) Thrown if the specified set is null. 109 * 110 * @see #add(Attribute) 111 */ 112 public boolean addAll(AttributeSet attributes); 113 }