/*
* @(#)PrintServiceAttributeSet.java 1.6 05/11/17
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package javax.print.attribute;
/**
* Interface PrintServiceAttributeSet specifies the interface for a set of
* print job attributes, i.e. printing attributes that implement interface
* {@link
* PrintServiceAttribute PrintServiceAttribute}. In the Print Service API,
* the Print Service instance uses a PrintServiceAttributeSet to report the
* status of the print service.
* <P>
* A PrintServiceAttributeSet is just an {@link AttributeSet AttributeSet}
* whose constructors and mutating operations guarantee an additional
* invariant,
* namely that all attribute values in the PrintServiceAttributeSet must be
* instances of interface {@link PrintServiceAttribute PrintServiceAttribute}.
* 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 PrintServiceAttributeSet 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 PrintServiceAttribute PrintServiceAttribute}.
* @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 PrintServiceAttribute
* PrintServiceAttribute}.
* @throws NullPointerException
* (Unchecked exception) Thrown if the specified set is null.
*
* @see #add(Attribute)
*/
public boolean addAll(AttributeSet attributes);
}