javax.print.attribute
Interface PrintJobAttributeSet

All Superinterfaces:
AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet
All Known Implementing Classes:
HashPrintJobAttributeSet sample code for javax.print.attribute.HashPrintJobAttributeSet definition code for javax.print.attribute.HashPrintJobAttributeSet

public interface PrintJobAttributeSet
extends AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet

Interface PrintJobAttributeSet specifies the interface for a set of print job attributes, i.e. printing attributes that implement interface PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute . In the Print Service API, a service uses a PrintJobAttributeSet to report the status of a print job.

A PrintJobAttributeSet is just an AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet whose constructors and mutating operations guarantee an additional invariant, namely that all attribute values in the PrintJobAttributeSet must be instances of interface PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute . The add(Attribute) sample code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) , and addAll(AttributeSet) sample code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet) definition code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet) operations are respecified below to guarantee this additional invariant.


Method Summary
 boolean add sample code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) (Attribute sample code for javax.print.attribute.Attribute definition code for 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).
 boolean addAll sample code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet) definition code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet) (AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet  attributes)
          Adds all of the elements in the specified set to this attribute.
 
Methods inherited from interface javax.print.attribute.AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet
clear sample code for javax.print.attribute.AttributeSet.clear() definition code for javax.print.attribute.AttributeSet.clear() , containsKey sample code for javax.print.attribute.AttributeSet.containsKey(java.lang.Class) definition code for javax.print.attribute.AttributeSet.containsKey(java.lang.Class) , containsValue sample code for javax.print.attribute.AttributeSet.containsValue(javax.print.attribute.Attribute) definition code for javax.print.attribute.AttributeSet.containsValue(javax.print.attribute.Attribute) , equals sample code for javax.print.attribute.AttributeSet.equals(java.lang.Object) definition code for javax.print.attribute.AttributeSet.equals(java.lang.Object) , get sample code for javax.print.attribute.AttributeSet.get(java.lang.Class) definition code for javax.print.attribute.AttributeSet.get(java.lang.Class) , hashCode sample code for javax.print.attribute.AttributeSet.hashCode() definition code for javax.print.attribute.AttributeSet.hashCode() , isEmpty sample code for javax.print.attribute.AttributeSet.isEmpty() definition code for javax.print.attribute.AttributeSet.isEmpty() , remove sample code for javax.print.attribute.AttributeSet.remove(javax.print.attribute.Attribute) definition code for javax.print.attribute.AttributeSet.remove(javax.print.attribute.Attribute) , remove sample code for javax.print.attribute.AttributeSet.remove(java.lang.Class) definition code for javax.print.attribute.AttributeSet.remove(java.lang.Class) , size sample code for javax.print.attribute.AttributeSet.size() definition code for javax.print.attribute.AttributeSet.size() , toArray sample code for javax.print.attribute.AttributeSet.toArray() definition code for javax.print.attribute.AttributeSet.toArray()
 

Method Detail

add sample code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute)

boolean add(Attribute sample code for javax.print.attribute.Attribute definition code for 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).

Specified by:
add sample code for javax.print.attribute.AttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.AttributeSet.add(javax.print.attribute.Attribute) in interface AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet
Parameters:
attribute - Attribute value to be added to this attribute set.
Returns:
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 sample code for javax.print.attribute.UnmodifiableSetException definition code for javax.print.attribute.UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the add() operation.
ClassCastException sample code for java.lang.ClassCastException definition code for java.lang.ClassCastException - (unchecked exception) Thrown if the attribute is not an instance of interface PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute .
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - (unchecked exception) Thrown if the attribute is null.

addAll sample code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet) definition code for javax.print.attribute.PrintJobAttributeSet.addAll(javax.print.attribute.AttributeSet)

boolean addAll(AttributeSet sample code for javax.print.attribute.AttributeSet definition code for 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 add(Attribute) sample code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.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.

Specified by:
addAll sample code for javax.print.attribute.AttributeSet.addAll(javax.print.attribute.AttributeSet) definition code for javax.print.attribute.AttributeSet.addAll(javax.print.attribute.AttributeSet) in interface AttributeSet sample code for javax.print.attribute.AttributeSet definition code for javax.print.attribute.AttributeSet
Parameters:
attributes - whose elements are to be added to this attribute set.
Returns:
true if this attribute set changed as a result of the call.
Throws:
UnmodifiableSetException sample code for javax.print.attribute.UnmodifiableSetException definition code for javax.print.attribute.UnmodifiableSetException - (Unchecked exception) Thrown if this attribute set does not support the addAll() method.
ClassCastException sample code for java.lang.ClassCastException definition code for java.lang.ClassCastException - (Unchecked exception) Thrown if some element in the specified set is not an instance of interface PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute .
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - (Unchecked exception) Thrown if the specified set is null.
See Also:
add(Attribute) sample code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute) definition code for javax.print.attribute.PrintJobAttributeSet.add(javax.print.attribute.Attribute)