DocAttributeSet (Java SE 15 & JDK 15) (original) (raw)

All Superinterfaces:

[AttributeSet](AttributeSet.html "interface in javax.print.attribute")

All Known Implementing Classes:

[HashDocAttributeSet](HashDocAttributeSet.html "class in javax.print.attribute")

public interface DocAttributeSet extends AttributeSet

Interface DocAttributeSet specifies the interface for a set of doc attributes, i.e. printing attributes that implement interfaceDocAttribute. In the Print Service API, the client uses a DocAttributeSet to specify the characteristics of an individual doc and the print job settings to be applied to an individual doc.

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

• Method Summary

Methods declared in interface javax.print.attribute.AttributeSet

[clear](AttributeSet.html#clear%28%29), [containsKey](AttributeSet.html#containsKey%28java.lang.Class%29), [containsValue](AttributeSet.html#containsValue%28javax.print.attribute.Attribute%29), [equals](AttributeSet.html#equals%28java.lang.Object%29), [get](AttributeSet.html#get%28java.lang.Class%29), [hashCode](AttributeSet.html#hashCode%28%29), [isEmpty](AttributeSet.html#isEmpty%28%29), [remove](AttributeSet.html#remove%28java.lang.Class%29), [remove](AttributeSet.html#remove%28javax.print.attribute.Attribute%29), [size](AttributeSet.html#size%28%29), [toArray](AttributeSet.html#toArray%28%29)

• 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:
  [add](AttributeSet.html#add%28javax.print.attribute.Attribute%29) in interface [AttributeSet](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](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the add() operation
  [ClassCastException](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if the attribute is not an instance of interface DocAttribute
  [NullPointerException](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if the attribute is null

  • addAll

  Adds all of the elements in the specified set to this attribute. The outcome is the same as if the 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, 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:
  [addAll](AttributeSet.html#addAll%28javax.print.attribute.AttributeSet%29) in interface [AttributeSet](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](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the addAll() method
  [ClassCastException](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if some element in the specified set is not an instance of interface DocAttribute
  [NullPointerException](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if the specified set is null
  See Also:
  add(Attribute)