javax.print.attribute

Class HashAttributeSet

public class HashAttributeSet extends Object implements AttributeSet, Serializable

HashAttributeSet provides an implementation of {@link javax.print.attribute.AttributeSet}.

Constructor Summary
	HashAttributeSet() Creates an empty `HashAttributeSet` object.
	HashAttributeSet(Attribute attribute) Creates a `HashAttributeSet` object with the given attribute in it.
	HashAttributeSet(Attribute[] attributes) Creates a `HashAttributeSet` object with the given attributes in it.
	HashAttributeSet(AttributeSet attributes) Creates a `HashAttributeSet` object with attributes of the given attributes set in it.
protected	HashAttributeSet(Class<?> interfaceName) Creates an empty `HashAttributeSet` object.
protected	HashAttributeSet(Attribute attribute, Class<?> interfaceName) Creates a `HashAttributeSet` object with the given attribute in it.
protected	HashAttributeSet(Attribute[] attributes, Class<?> interfaceName) Creates a `HashAttributeSet` object with the given attributes in it.
protected	HashAttributeSet(AttributeSet attributes, Class<?> interfaceName) Creates a `HashAttributeSet` object with attributes of the given attributes set in it.

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

Constructor Detail

HashAttributeSet

public HashAttributeSet()

Creates an empty HashAttributeSet object.

HashAttributeSet

public HashAttributeSet(Attribute attribute)

Creates a HashAttributeSet object with the given attribute in it.

Parameters: attribute the attribute to put into the set

Throws: NullPointerException if attribute is null

HashAttributeSet

public HashAttributeSet(Attribute[] attributes)

Creates a HashAttributeSet object with the given attributes in it.

Parameters: attributes the array of attributes to put into the set. If null an empty set is created.

Throws: NullPointerException if one of the attributes of the given array is null.

HashAttributeSet

public HashAttributeSet(AttributeSet attributes)

Creates a HashAttributeSet object with attributes of the given attributes set in it.

Parameters: attributes the attributes set to put into the set. If null an empty set is created.

HashAttributeSet

protected HashAttributeSet(Class<?> interfaceName)

Creates an empty HashAttributeSet object.

Parameters: interfaceName the interface that all members must implement

Throws: NullPointerException if interfaceName is null

HashAttributeSet

protected HashAttributeSet(Attribute attribute, Class<?> interfaceName)

Creates a HashAttributeSet object with the given attribute in it.

Parameters: attribute the attribute to put into the set. interfaceName the interface that all members must implement.

Throws: ClassCastException if attribute is not an interface of interfaceName NullPointerException if attribute or interfaceName is null

HashAttributeSet

protected HashAttributeSet(Attribute[] attributes, Class<?> interfaceName)

Creates a HashAttributeSet object with the given attributes in it.

Parameters: attributes the array of attributes to put into the set. If null an empty set is created. interfaceName the interface that all members must implement.

Throws: ClassCastException if any element of attributes is not an interface of interfaceName NullPointerException if attributes or interfaceName is null

HashAttributeSet

protected HashAttributeSet(AttributeSet attributes, Class<?> interfaceName)

Creates a HashAttributeSet object with attributes of the given attributes set in it.

Parameters: attributes the attributes set to put into the set. If null an empty set is created. interfaceName the interface that all members must implement.

Throws: ClassCastException if any element of attributes is not an interface of interfaceName

Method Detail

add

public 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

public 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.

clear

public void clear()

Removes all attributes from this attribute set.

Throws: UnmodifiableSetException if the set does not support modification.

containsKey

public 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

public 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

public 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.

Parameters: obj the Object to test.

Returns: true if equal, false otherwise.

get

public 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

public int hashCode()

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

Returns: The hashcode for this attribute set.

isEmpty

public boolean isEmpty()

Checks if the attribute set is empty.

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

remove

public 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

public 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

public int size()

Returns the number of elements in this attribute set.

Returns: The number of elements.

toArray

public Attribute[] toArray()

Returns the content of the attribute set as an array

Returns: An array of attributes.