You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
110 lines
3.9 KiB
110 lines
3.9 KiB
/*
|
|
* Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
|
|
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
|
|
|
|
package javax.print.attribute;
|
|
|
|
/**
|
|
* Interface PrintJobAttributeSet specifies the interface for a set of print
|
|
* job attributes, i.e. printing attributes that implement interface {@link
|
|
* PrintJobAttribute PrintJobAttribute}. In the Print Service API, a
|
|
* service uses a PrintJobAttributeSet to report the status of a print job.
|
|
* <P>
|
|
* A PrintJobAttributeSet is just an {@link AttributeSet AttributeSet} whose
|
|
* constructors and mutating operations guarantee an additional invariant,
|
|
* namely that all attribute values in the PrintJobAttributeSet must be
|
|
* instances of interface {@link PrintJobAttribute PrintJobAttribute}.
|
|
* The {@link #add(Attribute) add(Attribute)}, and
|
|
* {@link #addAll(AttributeSet) >addAll(AttributeSet)} operations
|
|
* are respecified below to guarantee this additional invariant.
|
|
* <P>
|
|
*
|
|
* @author Alan Kaminsky
|
|
*/
|
|
public interface PrintJobAttributeSet 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 PrintJobAttribute PrintJobAttribute}.
|
|
* @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) add(Attribute)}
|
|
* 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 PrintJobAttribute
|
|
* PrintJobAttribute}.
|
|
* @throws NullPointerException
|
|
* (Unchecked exception) Thrown if the specified set is null.
|
|
*
|
|
* @see #add(Attribute)
|
|
*/
|
|
public boolean addAll(AttributeSet attributes);
|
|
}
|