1 /*
2 * Copyright 2000-2001 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26
27 package javax.print.attribute;
28
29 /**
30 * Interface PrintJobAttributeSet specifies the interface for a set of print
31 * job attributes, i.e. printing attributes that implement interface {@link
32 * PrintJobAttribute PrintJobAttribute}. In the Print Service API, a
33 * service uses a PrintJobAttributeSet to report the status of a print job.
34 * <P>
35 * A PrintJobAttributeSet is just an {@link AttributeSet AttributeSet} whose
36 * constructors and mutating operations guarantee an additional invariant,
37 * namely that all attribute values in the PrintJobAttributeSet must be
38 * instances of interface {@link PrintJobAttribute PrintJobAttribute}.
39 * The {@link #add(Attribute) <CODE>add(Attribute)</CODE>}, and
40 * {@link #addAll(AttributeSet) <CODE>addAll(AttributeSet)</CODE>} operations
41 * are respecified below to guarantee this additional invariant.
42 * <P>
43 *
44 * @author Alan Kaminsky
45 */
46 public interface PrintJobAttributeSet extends AttributeSet {
47
48 /**
49 * Adds the specified attribute value to this attribute set if it is not
50 * already present, first removing any existing value in the same
51 * attribute category as the specified attribute value (optional
52 * operation).
53 *
54 * @param attribute Attribute value to be added to this attribute set.
55 *
56 * @return <tt>true</tt> if this attribute set changed as a result of
57 * the call, i.e., the given attribute value was not already a
58 * member of this attribute set.
59 *
60 * @throws UnmodifiableSetException
61 * (unchecked exception) Thrown if this attribute set does not
62 * support the <CODE>add()</CODE> operation.
63 * @throws ClassCastException
64 * (unchecked exception) Thrown if the <CODE>attribute</CODE> is
65 * not an instance of interface
66 * {@link PrintJobAttribute PrintJobAttribute}.
67 * @throws NullPointerException
68 * (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
69 */
70 public boolean add(Attribute attribute);
71
72 /**
73 * Adds all of the elements in the specified set to this attribute.
74 * The outcome is the same as if the
75 * {@link #add(Attribute) <CODE>add(Attribute)</CODE>}
76 * operation had been applied to this attribute set successively with
77 * each element from the specified set. If none of the categories in the
78 * specified set are the same as any categories in this attribute set,
79 * the <tt>addAll()</tt> operation effectively modifies this attribute
80 * set so that its value is the <i>union</i> of the two sets.
81 * <P>
82 * The behavior of the <CODE>addAll()</CODE> operation is unspecified if
83 * the specified set is modified while the operation is in progress.
84 * <P>
85 * If the <CODE>addAll()</CODE> operation throws an exception, the effect
86 * on this attribute set's state is implementation dependent; elements
87 * from the specified set before the point of the exception may or
88 * may not have been added to this attribute set.
89 *
90 * @param attributes whose elements are to be added to this attribute
91 * set.
92 *
93 * @return <tt>true</tt> if this attribute set changed as a result of
94 * the call.
95 *
96 * @throws UnmodifiableSetException
97 * (Unchecked exception) Thrown if this attribute set does not
98 * support the <tt>addAll()</tt> method.
99 * @throws ClassCastException
100 * (Unchecked exception) Thrown if some element in the specified
101 * set is not an instance of interface {@link PrintJobAttribute
102 * PrintJobAttribute}.
103 * @throws NullPointerException
104 * (Unchecked exception) Thrown if the specified set is null.
105 *
106 * @see #add(Attribute)
107 */
108 public boolean addAll(AttributeSet attributes);
109 }
Save This Page