jdk/src/share/classes/javax/print/attribute/DocAttributeSet.java
changeset 2 90ce3da70b43
child 5506 202f599c92aa
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/share/classes/javax/print/attribute/DocAttributeSet.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,111 @@
+/*
+ * Copyright 2000-2001 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+
+package javax.print.attribute;
+
+/**
+ * Interface DocAttributeSet specifies the interface for a set of doc
+ * attributes, i.e. printing attributes that implement interface {@link
+ * DocAttribute DocAttribute}. In the Print Service API, the client uses a
+ * DocAttributeSet to specify the characteristics of an individual doc and
+ * the print job settings to be applied to an individual doc.
+ * <P>
+ * A DocAttributeSet is just an {@link AttributeSet AttributeSet} whose
+ * constructors and mutating operations guarantee an additional invariant,
+ * namely that all attribute values in the DocAttributeSet must be instances
+ * of interface {@link DocAttribute DocAttribute}.
+ * The {@link #add(Attribute) <CODE>add(Attribute)</CODE>}, and
+ * {@link #addAll(AttributeSet) <CODE>addAll(AttributeSet)</CODE>} operations
+ * are respecified below to guarantee this additional invariant.
+ * <P>
+ *
+ * @author  Alan Kaminsky
+ */
+public interface DocAttributeSet extends AttributeSet {
+
+
+    /**
+     * Adds the specified attribute value to this attribute set if it is not
+     * already present, first removing any existing value in the same
+     * attribute category as the specified attribute value (optional
+     * operation).
+     *
+     * @param  attribute  Attribute value to be added to this attribute set.
+     *
+     * @return  <tt>true</tt> if this attribute set changed as a result of
+     *          the call, i.e., the given attribute value was not already a
+     *          member of this attribute set.
+     *
+     * @throws  UnmodifiableSetException
+     *     (unchecked exception) Thrown if this attribute set does not
+     *     support the <CODE>add()</CODE> operation.
+     * @throws  ClassCastException
+     *     (unchecked exception) Thrown if the <CODE>attribute</CODE> is
+     *     not an instance of interface
+     *     {@link DocAttribute DocAttribute}.
+     * @throws  NullPointerException
+     *    (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
+     */
+    public boolean add(Attribute attribute);
+
+    /**
+     * Adds all of the elements in the specified set to this attribute.
+     * The outcome is  the same as if the
+     * {@link #add(Attribute) <CODE>add(Attribute)</CODE>}
+     * operation had been applied to this attribute set successively with
+     * each element from the specified set. If none of the categories in the
+     * specified set  are the same as any categories in this attribute set,
+     * the <tt>addAll()</tt> operation effectively modifies this attribute
+     * set so that its value is the <i>union</i> of the two sets.
+     * <P>
+     * The behavior of the <CODE>addAll()</CODE> operation is unspecified if
+     * the specified set is modified while the operation is in progress.
+     * <P>
+     * If the <CODE>addAll()</CODE> operation throws an exception, the effect
+     * on this attribute set's state is implementation dependent; elements
+     * from the specified set before the point of the exception may or
+     * may not have been added to this attribute set.
+     *
+     * @param  attributes  whose elements are to be added to this attribute
+     *            set.
+     *
+     * @return  <tt>true</tt> if this attribute set changed as a result of
+     *          the call.
+     *
+     * @throws  UnmodifiableSetException
+     *     (Unchecked exception) Thrown if this attribute set does not
+     *     support the <tt>addAll()</tt> method.
+     * @throws  ClassCastException
+     *     (Unchecked exception) Thrown if some element in the specified
+     *     set is not an instance of interface {@link DocAttribute
+     *     DocAttribute}.
+     * @throws  NullPointerException
+     *     (Unchecked exception) Thrown if the specified  set is null.
+     *
+     * @see #add(Attribute)
+     */
+   public boolean addAll(AttributeSet attributes);
+}