Interface PrintJobAttributeSet
- All Superinterfaces:
AttributeSet
- All Known Implementing Classes:
HashPrintJobAttributeSet
Interface
PrintJobAttributeSet specifies the interface for a set of
print job attributes, i.e. printing attributes that implement interface
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
whose constructors and mutating operations guarantee an additional invariant,
namely that all attribute values in the PrintJobAttributeSet must be
instances of interface PrintJobAttribute. The
add(Attribute), and
addAll(AttributeSet) operations are respecified
below to guarantee this additional invariant.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds 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).booleanaddAll(AttributeSet attributes) Adds all of the elements in the specified set to this attribute.Methods declared in interface javax.print.attribute.AttributeSet
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, remove, remove, size, toArray
-
Method Details
-
add
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:
addin interfaceAttributeSet- Parameters:
attribute- attribute value to be added to this attribute set- Returns:
trueif 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- if this attribute set does not support theadd()operationClassCastException- if theattributeis not an instance of interfacePrintJobAttributeNullPointerException- if theattributeisnull
-
addAll
Adds all of the elements in the specified set to this attribute. The outcome is the same as if theadd(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, theaddAll()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:
addAllin interfaceAttributeSet- Parameters:
attributes- whose elements are to be added to this attribute set- Returns:
trueif this attribute set changed as a result of the call- Throws:
UnmodifiableSetException- if this attribute set does not support theaddAll()methodClassCastException- if some element in the specified set is not an instance of interfacePrintJobAttributeNullPointerException- if the specified set isnull- See Also:
-