OpenJDK 1.22 · javax.print.attribute.AttributeSet

Interface AttributeSet specifies the interface for a set of printing attributes. A printing attribute is an object whose class implements interface Attribute.

An attribute set contains a group of attribute values, where duplicate values are not allowed in the set. Furthermore, each value in an attribute set is a member of some category, and at most one value in any particular category is allowed in the set. For an attribute set, the values are Attribute objects, and the categories are Class objects. An attribute's category is the class (or interface) at the root of the class hierarchy for that kind of attribute. Note that an attribute object's category may be a superclass of the attribute object's class rather than the attribute object's class itself. An attribute object's category is determined by calling the getCategory() method defined in interface Attribute.

The interfaces of an AttributeSet resemble those of the Java Collections API's java.util.Map interface, but is more restrictive in the types it will accept, and combines keys and values into an Attribute.

Attribute sets are used in several places in the Print Service API. In each context, only certain kinds of attributes are allowed to appear in the attribute set, as determined by the tagging interfaces which the attribute class implements -- DocAttribute, PrintRequestAttribute, PrintJobAttribute, and PrintServiceAttribute. There are four specializations of an attribute set that are restricted to contain just one of the four kinds of attribute -- DocAttributeSet, PrintRequestAttributeSet, PrintJobAttributeSet, and PrintServiceAttributeSet, respectively. Note that many attribute classes implement more than one tagging interface and so may appear in more than one context.

A DocAttributeSet, containing DocAttributes, specifies the characteristics of an individual doc and the print job settings to be applied to an individual doc.
A PrintRequestAttributeSet, containing PrintRequestAttributes, specifies the settings to be applied to a whole print job and to all the docs in the print job.
A PrintJobAttributeSet, containing PrintJobAttributes, reports the status of a print job.
A PrintServiceAttributeSet, containing PrintServiceAttributes, reports the status of a Print Service instance.

In some contexts, the client is only allowed to examine an attribute set's contents but not change them (the set is read-only). In other places, the client is allowed both to examine and to change an attribute set's contents (the set is read-write). For a read-only attribute set, calling a mutating operation throws an UnmodifiableSetException.

The Print Service API provides one implementation of interface AttributeSet, class HashAttributeSet. A client can use class HashAttributeSet or provide its own implementation of interface AttributeSet. The Print Service API also provides implementations of interface AttributeSet's subinterfaces -- classes HashDocAttributeSet, HashPrintRequestAttributeSet, HashPrintJobAttributeSet, and HashPrintServiceAttributeSet.

Method Summary

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) Adds the specified attribute 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.
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) Adds all of the elements in the specified set to this attribute.
public void	clear() Removes all attributes from this attribute set.
public boolean	Returns: `true` if this attribute set contains an attribute value for the specified category containsKey(Class<?> whose presence in this attribute set is to be tested category) Returns `true` if this attribute set contains an attribute for the specified category.
public boolean	Returns: `true` if this attribute set contains the given attribute value containsValue(Attribute attribute value whose presence in this attribute set is to be tested attribute) Returns `true` if this attribute set contains the given attribute value.
public boolean	Returns: `true` if the specified object is equal to this attribute set equals(Object to be compared for equality with this attribute set object) Compares the specified object with this attribute set for equality.
public Attribute	Returns: the attribute value in the given attribute category contained in this attribute set, or `null` if this attribute set does not contain any attribute value in the given attribute category get(Class<?> attribute category whose associated attribute value is to be returned. It must be a `Class` that implements interface `Attribute`. category) Returns the attribute value which this attribute set contains in the given attribute category.
public int	Returns: the hash code value for this attribute set hashCode() Returns the hash code value for this attribute set.
public boolean	Returns: `true` if this attribute set contains no attributes isEmpty() Returns `true` if this attribute set contains no attributes.
public boolean	Returns: `true` if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set remove(Class<?> attribute category to be removed from this attribute set category) Removes any attribute for this category from this attribute set if present.
public boolean	Returns: `true` if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set remove(Attribute attribute value to be removed from this attribute set attribute) Removes the specified attribute from this attribute set if present.
public int	Returns: the number of attributes in this attribute set size() Returns the number of attributes in this attribute set.
public Attribute[]	Returns: the `Attributes` contained in this set as an array, zero length if the `AttributeSet` is empty toArray() Returns an array of the attributes contained in this set.

Method Detail

add back to summary

add	back to summary
public boolean add(Attribute attribute) Adds the specified attribute 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. 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 Exceptions NullPointerException: if the `attribute` is `null` UnmodifiableSetException: if this attribute set does not support the `add()` operation

public boolean add(Attribute attribute)

Adds the specified attribute 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.

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

Exceptions

NullPointerException:: if the attribute is null
UnmodifiableSetException:: if this attribute set does not support the add() operation

addAll back to summary

addAll	back to summary
public boolean addAll(AttributeSet attributes) 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. The behavior of the `addAll(AttributeSet)` operation is unspecified if the specified set is modified while the operation is in progress. If the `addAll(AttributeSet)` 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 Exceptions UnmodifiableSetException: if this attribute set does not support the `addAll(AttributeSet)` method NullPointerException: if some element in the specified set is `null` See Also `add(Attribute)`

public boolean addAll(AttributeSet attributes)

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. The behavior of the addAll(AttributeSet) operation is unspecified if the specified set is modified while the operation is in progress.

If the addAll(AttributeSet) 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

Exceptions

UnmodifiableSetException:: if this attribute set does not support the addAll(AttributeSet) method
NullPointerException:: if some element in the specified set is null

See Also

add(Attribute)

clear back to summary

clear	back to summary
public void clear() Removes all attributes from this attribute set. Exceptions UnmodifiableSetException: if this attribute set does not support the `clear()` operation

public void clear()

Removes all attributes from this attribute set.

Exceptions

UnmodifiableSetException:: if this attribute set does not support the clear() operation

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Class<?> category) Returns `true` if this attribute set contains an attribute for the specified category. Parameters category:Class<?> whose presence in this attribute set is to be tested Returns:boolean `true` if this attribute set contains an attribute value for the specified category

public boolean containsKey(Class<?> category)

Returns true if this attribute set contains an attribute for the specified category.

Parameters

category:Class<?>: whose presence in this attribute set is to be tested

Returns:boolean

true if this attribute set contains an attribute value for the specified category

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Attribute attribute) Returns `true` if this attribute set contains the given attribute value. Parameters attribute:Attribute attribute value whose presence in this attribute set is to be tested Returns:boolean `true` if this attribute set contains the given attribute value

public boolean containsValue(Attribute attribute)

Returns true if this attribute set contains the given attribute value.

Parameters

attribute:Attribute: attribute value whose presence in this attribute set is to be tested

Returns:boolean

true if this attribute set contains the given attribute value

equals back to summary

equals	back to summary
public boolean equals(Object object) Compares the specified object with this attribute set for equality. Returns `true` if the given object is also an attribute set and the two attribute sets contain the same attribute category-attribute value mappings. This ensures that the `equals()` method works properly across different implementations of the `AttributeSet` interface. Parameters object:Object to be compared for equality with this attribute set Returns:boolean `true` if the specified object is equal to this attribute set

public boolean equals(Object object)

Compares the specified object with this attribute set for equality. Returns true if the given object is also an attribute set and the two attribute sets contain the same attribute category-attribute value mappings. This ensures that the equals() method works properly across different implementations of the AttributeSet interface.

Parameters

object:Object: to be compared for equality with this attribute set

Returns:boolean

true if the specified object is equal to this attribute set

get back to summary

get	back to summary
public Attribute get(Class<?> category) Returns the attribute value which this attribute set contains in the given attribute category. Returns `null` if this attribute set does not contain any attribute value in the given attribute category. Parameters category:Class<?> attribute category whose associated attribute value is to be returned. It must be a `Class` that implements interface `Attribute`. Returns:Attribute the attribute value in the given attribute category contained in this attribute set, or `null` if this attribute set does not contain any attribute value in the given attribute category Exceptions NullPointerException: if the `category` is `null` ClassCastException: if the `category` is not a `Class` that implements interface `Attribute`

public Attribute get(Class<?> category)

Returns the attribute value which this attribute set contains in the given attribute category. Returns null if this attribute set does not contain any attribute value in the given attribute category.

Parameters

category:Class<?>: attribute category whose associated attribute value is to be returned. It must be a Class that implements interface Attribute.

Returns:Attribute

the attribute value in the given attribute category contained in this attribute set, or null if this attribute set does not contain any attribute value in the given attribute category

Exceptions

NullPointerException:: if the category is null
ClassCastException:: if the category is not a Class that implements interface Attribute

hashCode back to summary

hashCode	back to summary
public int hashCode() Returns the hash code value for this attribute set. The hash code of an attribute set is defined to be the sum of the hash codes of each entry in the `AttributeSet`. This ensures that `t1.equals(t2)` implies that `t1.hashCode()==t2.hashCode()` for any two attribute sets `t1` and `t2`, as required by the general contract of `Object.hashCode()`. Returns:int the hash code value for this attribute set

public int hashCode()

Returns the hash code value for this attribute set. The hash code of an attribute set is defined to be the sum of the hash codes of each entry in the AttributeSet. This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two attribute sets t1 and t2, as required by the general contract of Object.hashCode().

Returns:int: the hash code value for this attribute set

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Returns `true` if this attribute set contains no attributes. Returns:boolean `true` if this attribute set contains no attributes

public boolean isEmpty()

Returns true if this attribute set contains no attributes.

Returns:boolean: true if this attribute set contains no attributes

remove back to summary

remove	back to summary
public boolean remove(Class<?> category) Removes any attribute for this category from this attribute set if present. If `category` is `null`, then `remove()` does nothing and returns `false`. Parameters category:Class<?> attribute category to be removed from this attribute set Returns:boolean `true` if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set Exceptions UnmodifiableSetException: if this attribute set does not support the `remove()` operation

public boolean remove(Class<?> category)

Removes any attribute for this category from this attribute set if present. If category is null, then remove() does nothing and returns false.

Parameters

category:Class<?>: attribute category to be removed from this attribute set

Returns:boolean

true if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set

Exceptions

UnmodifiableSetException:: if this attribute set does not support the remove() operation

remove back to summary

remove	back to summary
public boolean remove(Attribute attribute) Removes the specified attribute from this attribute set if present. If `attribute` is `null`, then `remove()` does nothing and returns `false`. Parameters attribute:Attribute attribute value to be removed from this attribute set Returns:boolean `true` if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set Exceptions UnmodifiableSetException: if this attribute set does not support the `remove()` operation

public boolean remove(Attribute attribute)

Removes the specified attribute from this attribute set if present. If attribute is null, then remove() does nothing and returns false.

Parameters

attribute:Attribute: attribute value to be removed from this attribute set

Returns:boolean

true if this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set

Exceptions

UnmodifiableSetException:: if this attribute set does not support the remove() operation

size back to summary

size	back to summary
public int size() Returns the number of attributes in this attribute set. If this attribute set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of attributes in this attribute set

public int size()

Returns the number of attributes in this attribute set. If this attribute set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int: the number of attributes in this attribute set

toArray back to summary

toArray	back to summary
public Attribute[] toArray() Returns an array of the attributes contained in this set. Returns:Attribute[] the `Attributes` contained in this set as an array, zero length if the `AttributeSet` is empty

public Attribute[] toArray()

Returns an array of the attributes contained in this set.

Returns:Attribute[]: the Attributes contained in this set as an array, zero length if the AttributeSet is empty

public Interface AttributeSet

Method Summary

Method Detail