OpenJDK 27 · javax.print.attribute.DocAttributeSet · APIdia, the JavaDoc alternative

Interface DocAttributeSet specifies the interface for a set of doc attributes, i.e. printing attributes that implement interface DocAttribute. 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. The add(Attribute), and addAll(AttributeSet) operations are respecified below to guarantee this additional invariant.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public boolean	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 add(Attribute attribute value to be added to this attribute set attribute) Redeclares javax.print.attribute.AttributeSet.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).
public boolean	Returns: `true` if this attribute set changed as a result of the call addAll(AttributeSet whose elements are to be added to this attribute set attributes) Redeclares javax.print.attribute.AttributeSet.addAll. Adds all of the elements in the specified set to this attribute.

public boolean

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

add(Attribute

attribute value to be added to this attribute set

attribute)

Redeclares javax.print.attribute.AttributeSet.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).

public boolean

Returns:

true if this attribute set changed as a result of the call

addAll(AttributeSet

whose elements are to be added to this attribute set

attributes)

Redeclares javax.print.attribute.AttributeSet.addAll.

Adds all of the elements in the specified set to this attribute.

Inherited from javax.print.attribute.AttributeSet:: clear containsKey containsValue equals get hashCode isEmpty remove remove size toArray

Method Detail

add back to summary

add	back to summary
public boolean add(Attribute attribute) Redeclares javax.print.attribute.AttributeSet.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). Parameters attribute:Attribute attribute value to be added to this attribute set Returns:boolean `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 Annotations @Override Exceptions UnmodifiableSetException: if this attribute set does not support the `add()` operation ClassCastException: if the `attribute` is not an instance of interface `DocAttribute` NullPointerException: if the `attribute` is `null`

public boolean add(Attribute attribute)

Redeclares javax.print.attribute.AttributeSet.add.

Parameters

attribute:Attribute: attribute value to be added to this attribute set

Returns:boolean

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

Annotations

@Override

Exceptions

UnmodifiableSetException:: if this attribute set does not support the add() operation
ClassCastException:: if the attribute is not an instance of interface DocAttribute
NullPointerException:: if the attribute is null

addAll back to summary

addAll	back to summary
public boolean addAll(AttributeSet attributes) Redeclares javax.print.attribute.AttributeSet.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, 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. Parameters attributes:AttributeSet whose elements are to be added to this attribute set Returns:boolean `true` if this attribute set changed as a result of the call Annotations @Override Exceptions UnmodifiableSetException: if this attribute set does not support the `addAll()` method ClassCastException: if some element in the specified set is not an instance of interface `DocAttribute` NullPointerException: if the specified set is `null` See Also `add(Attribute)`

public boolean addAll(AttributeSet attributes)

Redeclares javax.print.attribute.AttributeSet.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, 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.