PrintServiceAttributeSet (Java 2 Platform SE 5.0) (original) (raw)

javax.print.attribute

Interface PrintServiceAttributeSet

All Superinterfaces:

All Known Implementing Classes:

public interface PrintServiceAttributeSet

Interface PrintServiceAttributeSet specifies the interface for a set of print job attributes, i.e. printing attributes that implement interfacePrintServiceAttribute. In the Print Service API, the Print Service instance uses a PrintServiceAttributeSet to report the status of the print service.

A PrintServiceAttributeSet is just an AttributeSet whose constructors and mutating operations guarantee an additional invariant, namely that all attribute values in the PrintServiceAttributeSet must be instances of interface PrintServiceAttribute. The add(Attribute), andaddAll(AttributeSet) operations are respecified below to guarantee this additional invariant.

Method Summary
boolean	add(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(AttributeSet attributes) Adds all of the elements in the specified set to this attribute.

Methods inherited from interface javax.print.attribute.AttributeSet
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, remove, remove, size, toArray

Method Detail

add

boolean add(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](../../../javax/print/attribute/AttributeSet.html#add%28javax.print.attribute.Attribute%29) in interface [AttributeSet](../../../javax/print/attribute/AttributeSet.html "interface in javax.print.attribute")

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](../../../javax/print/attribute/UnmodifiableSetException.html "class in javax.print.attribute") - (unchecked exception) Thrown if this attribute set does not support the add() operation.

[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - (unchecked exception) Thrown if the attribute is not an instance of interfacePrintServiceAttribute.

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - (unchecked exception) Thrown if the attribute is null.

addAll

boolean addAll(AttributeSet attributes)

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, 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](../../../javax/print/attribute/AttributeSet.html#addAll%28javax.print.attribute.AttributeSet%29) in interface [AttributeSet](../../../javax/print/attribute/AttributeSet.html "interface in javax.print.attribute")

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](../../../javax/print/attribute/UnmodifiableSetException.html "class in javax.print.attribute") - (Unchecked exception) Thrown if this attribute set does not support the addAll() method.

[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - (Unchecked exception) Thrown if some element in the specified set is not an instance of interface PrintServiceAttribute.

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - (Unchecked exception) Thrown if the specified set is null.

See Also:

add(Attribute)

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.