| |
|
| java.lang.Object
 javax.print.attribute.HashAttributeSet
All known Subclasses: javax.print.attribute.HashDocAttributeSet, javax.print.attribute.HashPrintServiceAttributeSet, javax.print.attribute.HashPrintRequestAttributeSet, javax.print.attribute.HashPrintJobAttributeSet,
| HashAttributeSet | | public class HashAttributeSet implements AttributeSet,Serializable(Code) | | Class HashAttributeSet provides an AttributeSet
implementation with characteristics of a hash map.
author:
Alan Kaminsky |
| Constructor Summary | |
| public | HashAttributeSet()
Construct a new, empty attribute set. | | public | HashAttributeSet(Attribute attribute)
Construct a new attribute set,
initially populated with the given attribute. | | public | HashAttributeSet(Attribute[] attributes)
Construct a new attribute set,
initially populated with the values from the
given array. | | public | HashAttributeSet(AttributeSet attributes)
Construct a new attribute set,
initially populated with the values from the given set. | | protected | HashAttributeSet(Class interfaceName)
Construct a new, empty attribute set, where the members of
the attribute set are restricted to the given interface. | | protected | HashAttributeSet(Attribute attribute, Class interfaceName)
Construct a new attribute set, initially populated with the given
attribute, where the members of the attribute set are restricted to the
given interface. | | protected | HashAttributeSet(Attribute[] attributes, Class interfaceName)
Construct a new attribute set, where the members of the attribute
set are restricted to the given interface.
The new attribute set is populated
by adding the elements of attributes array to the set in
sequence, starting at index 0. | | protected | HashAttributeSet(AttributeSet attributes, Class interfaceName)
Construct a new attribute set, initially populated with the
values from the given set where the members of the attribute
set are restricted to the given interface.
Parameters:
attributes - set of attribute values to initialise the set. |
| Method Summary | |
| public boolean | add(Attribute attribute)
Adds the specified attribute to this attribute set if it is not
already present, first removing any existing in the same
attribute category as the specified attribute value. | | 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
HashAttributeSet.add(Attribute) 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. | | public void | clear()
Removes all attributes from this attribute set.
throws:
UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the clear() operation. | | public boolean | containsKey(Class category)
Returns true if this attribute set contains an
attribute for the specified category.
Parameters:
category - whose presence in this attribute set isto be tested. | | public boolean | containsValue(Attribute attribute)
Returns true if this attribute set contains the given
attribute.
Parameters:
attribute - value whose presence in this attribute set isto be tested. | | public boolean | equals(Object object)
Compares the specified object with this attribute set for equality. | | public Attribute | get(Class category)
Returns the attribute value which this attribute set contains in the
given attribute category. | | 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. | | public boolean | isEmpty()
Returns true if this attribute set contains no attributes. | | public boolean | remove(Class category)
Removes any attribute for this category from this attribute set if
present. | | public boolean | remove(Attribute attribute)
Removes the specified attribute from this attribute set if
present. | | public int | size()
Returns the number of attributes in this attribute set. | | public Attribute[] | toArray()
|
| HashAttributeSet | | public HashAttributeSet()(Code) | | Construct a new, empty attribute set.
|
| HashAttributeSet | | public HashAttributeSet(Attribute attribute)(Code) | | Construct a new attribute set,
initially populated with the given attribute.
Parameters:
attribute - Attribute value to add to the set.
exception:
NullPointerException - (unchecked exception) Thrown if attribute is null. |
| HashAttributeSet | | public HashAttributeSet(Attribute[] attributes)(Code) | | Construct a new attribute set,
initially populated with the values from the
given array. The new attribute set is populated by
adding the elements of attributes array to the set in
sequence, starting at index 0. Thus, later array elements may replace
earlier array elements if the array contains duplicate attribute
values or attribute categories.
Parameters:
attributes - Array of attribute values to add to the set. If null, an empty attribute set is constructed.
exception:
NullPointerException - (unchecked exception) Thrown if any element ofattributes is null. |
| HashAttributeSet | | public HashAttributeSet(AttributeSet attributes)(Code) | | Construct a new attribute set,
initially populated with the values from the given set.
Parameters:
attributes - Set of attributes from which to initialise this set.If null, an empty attribute set is constructed. |
| HashAttributeSet | | protected HashAttributeSet(Class interfaceName)(Code) | | Construct a new, empty attribute set, where the members of
the attribute set are restricted to the given interface.
Parameters:
interfaceName - The interface of which all members of thisattribute set must be an instance. It is assumed to be interface Attribute Attribute or a subinterface thereof.
exception:
NullPointerException - if interfaceName is null. |
| HashAttributeSet | | protected HashAttributeSet(Attribute attribute, Class interfaceName)(Code) | | Construct a new attribute set, initially populated with the given
attribute, where the members of the attribute set are restricted to the
given interface.
Parameters:
attribute - Attribute value to add to the set.
Parameters:
interfaceName - The interface of which all members of thisattribute set must be an instance. It is assumed to be interface Attribute Attribute or a subinterface thereof.
exception:
NullPointerException - (unchecked exception) Thrown if attribute is null.
exception:
NullPointerException - if interfaceName is null.
exception:
ClassCastException - (unchecked exception) Thrown if attribute is not an instance of interfaceName. |
| HashAttributeSet | | protected HashAttributeSet(Attribute[] attributes, Class interfaceName)(Code) | | Construct a new attribute set, where the members of the attribute
set are restricted to the given interface.
The new attribute set is populated
by adding the elements of attributes array to the set in
sequence, starting at index 0. Thus, later array elements may replace
earlier array elements if the array contains duplicate attribute
values or attribute categories.
Parameters:
attributes - Array of attribute values to add to the set. Ifnull, an empty attribute set is constructed.
Parameters:
interfaceName - The interface of which all members of thisattribute set must be an instance. It is assumed to be interface Attribute Attribute or a subinterface thereof.
exception:
NullPointerException - (unchecked exception) Thrown if any element ofattributes is null.
exception:
NullPointerException - if interfaceName is null.
exception:
ClassCastException - (unchecked exception) Thrown if any element ofattributes is not an instance ofinterfaceName. |
| HashAttributeSet | | protected HashAttributeSet(AttributeSet attributes, Class interfaceName)(Code) | | Construct a new attribute set, initially populated with the
values from the given set where the members of the attribute
set are restricted to the given interface.
Parameters:
attributes - set of attribute values to initialise the set. Ifnull, an empty attribute set is constructed.
Parameters:
interfaceName - The interface of which all members of thisattribute set must be an instance. It is assumed to be interface Attribute Attribute or a subinterface thereof.
exception:
ClassCastException - (unchecked exception) Thrown if any element ofattributes is not an instance ofinterfaceName. |
| add | | public boolean add(Attribute attribute)(Code) | | Adds the specified attribute to this attribute set if it is not
already present, first removing any existing in the same
attribute category as the specified attribute value.
Parameters:
attribute - Attribute value to be added to this attribute set. true if this attribute set changed as a result of thecall, i.e., the given attribute value was not already a member of this attribute set.
throws:
NullPointerException - (unchecked exception) Thrown if the attribute is null.
throws:
UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the add() operation. |
| addAll | | public boolean addAll(AttributeSet attributes)(Code) | | Adds all of the elements in the specified set to this attribute.
The outcome is the same as if the
HashAttributeSet.add(Attribute) 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 - whose elements are to be added to this attribute set. true if this attribute set changed as a result of thecall.
throws:
UnmodifiableSetException - (Unchecked exception) Thrown if this attribute set does not support the addAll(AttributeSet) method.
throws:
NullPointerException - (Unchecked exception) Thrown if some element in the specified set is null, or the set is null.
See Also: HashAttributeSet.add(Attribute) |
| clear | | public void clear()(Code) | | Removes all attributes from this attribute set.
throws:
UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the clear() operation. |
| containsKey | | public boolean containsKey(Class category)(Code) | | Returns true if this attribute set contains an
attribute for the specified category.
Parameters:
category - whose presence in this attribute set isto be tested. true if this attribute set contains an attribute value for the specified category. |
| containsValue | | public boolean containsValue(Attribute attribute)(Code) | | Returns true if this attribute set contains the given
attribute.
Parameters:
attribute - value whose presence in this attribute set isto be tested. true if this attribute set contains the given attribute value. |
| equals | | public boolean equals(Object object)(Code) | | 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 - to be compared for equality with this attribute set. true if the specified object is equal to this attribute set. |
| get | | public Attribute get(Class category)(Code) | | 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 - Attribute category whose associated attribute valueis to be returned. It must be ajava.lang.Class Classthat implements interface Attribute Attribute. The attribute value in the given attribute category containedin this attribute set, or null if this attribute setdoes not contain any attribute value in the given attributecategory.
throws:
NullPointerException - (unchecked exception) Thrown if the category is null.
throws:
ClassCastException - (unchecked exception) Thrown if the category is not a java.lang.Class Class that implements interface Attribute Attribute. |
| hashCode | | public int hashCode()(Code) | | 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
java.lang.Object.hashCode Object.hashCode() .
The hash code value for this attribute set. |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this attribute set contains no attributes.
true if this attribute set contains no attributes. |
| remove | | public boolean remove(Class category)(Code) | | 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 - Attribute category to be removed from thisattribute set. true if this attribute set changed as a result of thecall, i.e., the given attribute category had been a member of this attribute set.
throws:
UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the remove() operation. |
| remove | | public boolean remove(Attribute attribute)(Code) | | Removes the specified attribute from this attribute set if
present. If attribute is null, then
remove() does nothing and returns false.
Parameters:
attribute - Attribute value to be removed from this attribute set. true if this attribute set changed as a result of thecall, i.e., the given attribute value had been a member of this attribute set.
throws:
UnmodifiableSetException - (unchecked exception) Thrown if this attribute set does not support the remove() operation. |
| size | | public int size()(Code) | | Returns the number of attributes in this attribute set. If this
attribute set contains more than Integer.MAX_VALUE elements,
returns Integer.MAX_VALUE.
The number of attributes in this attribute set. |
| toArray | | public Attribute[] toArray()(Code) | | the Attributes contained in this set as an array, zero lengthif the AttributeSet is empty. |
|
|
|