javax.print.attribute
Interface AttributeSet

All Known Subinterfaces:
DocAttributeSet, PrintJobAttributeSet, PrintRequestAttributeSet, PrintServiceAttributeSet
All Known Implementing Classes:
HashAttributeSet, HashDocAttributeSet, HashPrintJobAttributeSet, HashPrintRequestAttributeSet, HashPrintServiceAttributeSet

public interface AttributeSet

AttributeSet is the top-level interface for sets of printing attributes in the Java Print Service API.

There are no duplicate values allowed in an attribute set and there is at most one attribute object contained per category type. Based on the Map interface the values of attribute sets are objects of type Attribute and the entries are the categories as Class instances.

The following specialized types of AttributeSet are available:

Attribute sets may be unmodifiable depending on the context of usage. If used as read-only attribute set modifying operations throw an UnmodifiableSetException.

The Java Print Service API provides implementation classes for the existing attribute set interfaces but applications may use their own implementations.


Method Summary
 boolean add(Attribute attribute)
          Adds the specified attribute value to this attribute set if it is not already present.
 boolean addAll(AttributeSet attributes)
          Adds all of the elements in the specified set to this attribute set.
 void clear()
          Removes all attributes from this attribute set.
 boolean containsKey(Class<?> category)
          Checks if this attributes set contains an attribute with the given category.
 boolean containsValue(Attribute attribute)
          Checks if this attribute set contains the given attribute.
 boolean equals(Object obj)
          Tests this set for equality with the given object.
 Attribute get(Class<?> category)
          Returns the attribute object contained in this set for the given attribute category.
 int hashCode()
          Returns the hashcode value.
 boolean isEmpty()
          Checks if the attribute set is empty.
 boolean remove(Attribute attribute)
          Removes the given attribute from the set.
 boolean remove(Class<?> category)
          Removes the attribute entry of the given category from the set.
 int size()
          Returns the number of elements in this attribute set.
 Attribute[] toArray()
          Returns the content of the attribute set as an array
 

Method Detail

add

boolean add(Attribute attribute)
Adds the specified attribute value to this attribute set if it is not already present. This operation removes any existing attribute of the same category before adding the given attribute to the set.

Parameters:
attribute - the attribute to add.
Returns:
true if the set is changed, false otherwise.
Throws:
NullPointerException - if the attribute is null.
UnmodifiableSetException - if the set does not support modification.

addAll

boolean addAll(AttributeSet attributes)
Adds all of the elements in the specified set to this attribute set.

Parameters:
attributes - the set of attributes to add.
Returns:
true if the set is changed, false otherwise.
Throws:
UnmodifiableSetException - if the set does not support modification.
See Also:
add(Attribute)

clear

void clear()
Removes all attributes from this attribute set.

Throws:
UnmodifiableSetException - if the set does not support modification.

containsKey

boolean containsKey(Class<?> category)
Checks if this attributes set contains an attribute with the given category.

Parameters:
category - the category to test for.
Returns:
true if an attribute of the category is contained in the set, false otherwise.

containsValue

boolean containsValue(Attribute attribute)
Checks if this attribute set contains the given attribute.

Parameters:
attribute - the attribute to test for.
Returns:
true if the attribute is contained in the set, false otherwise.

equals

boolean equals(Object obj)
Tests this set for equality with the given object. true is returned, if the given object is also of type AttributeSet and the contained attributes are the same as in this set.

Overrides:
equals in class Object
Parameters:
obj - the Object to test.
Returns:
true if equal, false otherwise.
See Also:
Object.hashCode()

get

Attribute get(Class<?> category)
Returns the attribute object contained in this set for the given attribute category.

Parameters:
category - the category of the attribute. A Class instance of a class implementing the Attribute interface.
Returns:
The attribute for this category or null if no attribute is contained for the given category.
Throws:
NullPointerException - if category is null.
ClassCastException - if category is not implementing Attribute.

hashCode

int hashCode()
Returns the hashcode value. The hashcode value is the sum of all hashcodes of the attributes contained in this set.

Overrides:
hashCode in class Object
Returns:
The hashcode for this attribute set.
See Also:
Object.equals(Object), System.identityHashCode(Object)

isEmpty

boolean isEmpty()
Checks if the attribute set is empty.

Returns:
true if the attribute set is empty, false otherwise.

remove

boolean remove(Attribute attribute)
Removes the given attribute from the set. If the given attribute is null nothing is done and false is returned.

Parameters:
attribute - the attribute to remove.
Returns:
true if removed, false in all other cases.
Throws:
UnmodifiableSetException - if the set does not support modification.

remove

boolean remove(Class<?> category)
Removes the attribute entry of the given category from the set. If the given category is null nothing is done and false is returned.

Parameters:
category - the category of the entry to be removed.
Returns:
true if an attribute is removed, false in all other cases.
Throws:
UnmodifiableSetException - if the set does not support modification.

size

int size()
Returns the number of elements in this attribute set.

Returns:
The number of elements.

toArray

Attribute[] toArray()
Returns the content of the attribute set as an array

Returns:
An array of attributes.