File Doc Category Size Date Package
PrintRequestAttributeSet.java API Doc Java SE 5 API 4140 Fri Aug 26 14:57:44 BST 2005 javax.print.attribute

PrintRequestAttributeSet

public interface PrintRequestAttributeSet implements AttributeSet

Interface PrintRequestAttributeSet specifies the interface for a set of print request attributes, i.e. printing attributes that implement interface {@link PrintRequestAttribute PrintRequestAttribute}. The client uses a PrintRequestAttributeSet to specify the settings to be applied to a whole print job and to all the docs in the print job.

PrintRequestAttributeSet is just an {@link AttributeSet AttributeSet} whose constructors and mutating operations guarantee an additional invariant, namely that all attribute values in the PrintRequestAttributeSet must be instances of interface {@link PrintRequestAttribute PrintRequestAttribute}. The {@link #add(Attribute) add(Attribute)}, and {@link #addAll(AttributeSet) addAll(AttributeSet)} operations are respecified below to guarantee this additional invariant.

author: Alan Kaminsky

Fields Summary
Constructors Summary
Methods Summary
public boolean add(javax.print.attribute.Attribute attribute)
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
true 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 add() operation.
throws
ClassCastException (unchecked exception) Thrown if the attribute is not an instance of interface {@link PrintRequestAttribute PrintRequestAttribute}.
throws
NullPointerException (unchecked exception) Thrown if the attribute is null.
public boolean addAll(javax.print.attribute.AttributeSet attributes)
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 addAll() operation effectively modifies this attribute set so that its value is the union of the two sets.
The behavior of the addAll() operation is unspecified if the specified set is modified while the operation is in progress.
If the addAll() 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
true if this attribute set changed as a result of the call.
throws
UnmodifiableSetException (Unchecked exception) Thrown if this attribute set does not support the addAll() method.
throws
ClassCastException (Unchecked exception) Thrown if some element in the specified set is not an instance of interface {@link PrintRequestAttribute PrintRequestAttribute}.
throws
NullPointerException (Unchecked exception) Thrown if the specified set is null.
see
#add(Attribute)