java.lang.Object
javax.print.attribute.HashAttributeSet
- All Implemented Interfaces:
Serializable,AttributeSet
- Direct Known Subclasses:
HashDocAttributeSet,HashPrintJobAttributeSet,HashPrintRequestAttributeSet,HashPrintServiceAttributeSet
Class
HashAttributeSet provides an AttributeSet
implementation with characteristics of a hash map.- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstruct a new, empty attribute set.protectedHashAttributeSet(Class<?> interfaceName) Construct a new, empty attribute set, where the members of the attribute set are restricted to the given interface.HashAttributeSet(Attribute attribute) Construct a new attribute set, initially populated with the given attribute.HashAttributeSet(Attribute[] attributes) Construct a new attribute set, initially populated with the values from the given array.protectedHashAttributeSet(Attribute[] attributes, Class<?> interfaceName) Construct a new attribute set, where the members of the attribute set are restricted to the given interface.protectedHashAttributeSet(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.HashAttributeSet(AttributeSet attributes) Construct a new attribute set, initially populated with the values from the given set.protectedHashAttributeSet(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. -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds 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.booleanaddAll(AttributeSet attributes) Adds all of the elements in the specified set to this attribute.voidclear()Removes all attributes from this attribute set.booleancontainsKey(Class<?> category) Returnstrueif this attribute set contains an attribute for the specified category.booleancontainsValue(Attribute attribute) Returnstrueif this attribute set contains the given attribute.booleanCompares the specified object with this attribute set for equality.Returns the attribute value which this attribute set contains in the given attribute category.inthashCode()Returns the hash code value for this attribute set.booleanisEmpty()Returnstrueif this attribute set contains no attributes.booleanRemoves any attribute for this category from this attribute set if present.booleanRemoves the specified attribute from this attribute set if present.intsize()Returns the number of attributes in this attribute set.toArray()Returns an array of the attributes contained in this set.
-
Constructor Details
-
HashAttributeSet
public HashAttributeSet()Construct a new, empty attribute set. -
HashAttributeSet
Construct a new attribute set, initially populated with the given attribute.- Parameters:
attribute- attribute value to add to the set- Throws:
NullPointerException- ifattributeisnull
-
HashAttributeSet
Construct a new attribute set, initially populated with the values from the given array. The new attribute set is populated by adding the elements ofattributesarray 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.- Throws:
NullPointerException- if any element ofattributesisnull
-
HashAttributeSet
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. Ifnull, an empty attribute set is constructed.
-
HashAttributeSet
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 this attribute set must be an instance. It is assumed to be interfaceAttributeor a subinterface thereof.- Throws:
NullPointerException- ifinterfaceNameisnull
-
HashAttributeSet
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 setinterfaceName- the interface of which all members of this attribute set must be an instance. It is assumed to be interfaceAttributeor a subinterface thereof.- Throws:
NullPointerException- ifattributeorinterfaceNamearenullClassCastException- ifattributeis not an instance ofinterfaceName
-
HashAttributeSet
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 ofattributesarray 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.interfaceName- the interface of which all members of this attribute set must be an instance. It is assumed to be interfaceAttributeor a subinterface thereof.- Throws:
NullPointerException- ifinterfaceNameisnull, or if any element ofattributesisnullClassCastException- if any element ofattributesis not an instance ofinterfaceName
-
HashAttributeSet
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.interfaceName- The interface of which all members of this attribute set must be an instance. It is assumed to be interfaceAttributeor a subinterface thereof.- Throws:
ClassCastException- if any element ofattributesis not an instance ofinterfaceName
-
-
Method Details
-
get
Returns the attribute value which this attribute set contains in the given attribute category. Returnsnullif this attribute set does not contain any attribute value in the given attribute category.- Specified by:
getin interfaceAttributeSet- Parameters:
category- attribute category whose associated attribute value is to be returned. It must be aClassthat implements interfaceAttribute.- Returns:
- the attribute value in the given attribute category contained in
this attribute set, or
nullif this attribute set does not contain any attribute value in the given attribute category - Throws:
NullPointerException- if thecategoryisnullClassCastException- if thecategoryis not aClassthat implements interfaceAttribute
-
add
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.- Specified by:
addin interfaceAttributeSet- Parameters:
attribute- attribute value to be added to this attribute set- Returns:
trueif 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- Throws:
NullPointerException- if theattributeisnullUnmodifiableSetException- if this attribute set does not support theadd()operation
-
remove
Removes any attribute for this category from this attribute set if present. Ifcategoryisnull, thenremove()does nothing and returnsfalse.- Specified by:
removein interfaceAttributeSet- Parameters:
category- attribute category to be removed from this attribute set- Returns:
trueif this attribute set changed as a result of the call, i.e., the given attribute category had been a member of this attribute set- Throws:
UnmodifiableSetException- if this attribute set does not support theremove()operation
-
remove
Removes the specified attribute from this attribute set if present. Ifattributeisnull, thenremove()does nothing and returnsfalse.- Specified by:
removein interfaceAttributeSet- Parameters:
attribute- attribute value to be removed from this attribute set- Returns:
trueif this attribute set changed as a result of the call, i.e., the given attribute value had been a member of this attribute set- Throws:
UnmodifiableSetException- if this attribute set does not support theremove()operation
-
containsKey
Returnstrueif this attribute set contains an attribute for the specified category.- Specified by:
containsKeyin interfaceAttributeSet- Parameters:
category- whose presence in this attribute set is to be tested- Returns:
trueif this attribute set contains an attribute value for the specified category
-
containsValue
Returnstrueif this attribute set contains the given attribute.- Specified by:
containsValuein interfaceAttributeSet- Parameters:
attribute- value whose presence in this attribute set is to be tested- Returns:
trueif this attribute set contains the given attribute value
-
addAll
Adds all of the elements in the specified set to this attribute. The outcome is the same as if theadd(Attribute)operation had been applied to this attribute set successively with each element from the specified set. The behavior of theaddAll(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.- Specified by:
addAllin interfaceAttributeSet- Parameters:
attributes- whose elements are to be added to this attribute set- Returns:
trueif this attribute set changed as a result of the call- Throws:
UnmodifiableSetException- if this attribute set does not support theaddAll(AttributeSet)methodNullPointerException- if some element in the specified set isnull, or the set isnull- See Also:
-
size
public int size()Returns the number of attributes in this attribute set. If this attribute set contains more thanInteger.MAX_VALUEelements, returnsInteger.MAX_VALUE.- Specified by:
sizein interfaceAttributeSet- Returns:
- the number of attributes in this attribute set
-
toArray
Returns an array of the attributes contained in this set.- Specified by:
toArrayin interfaceAttributeSet- Returns:
- the attributes contained in this set as an array, zero length if
the
AttributeSetis empty
-
clear
public void clear()Removes all attributes from this attribute set.- Specified by:
clearin interfaceAttributeSet- Throws:
UnmodifiableSetException- if this attribute set does not support theclear()operation
-
isEmpty
public boolean isEmpty()Returnstrueif this attribute set contains no attributes.- Specified by:
isEmptyin interfaceAttributeSet- Returns:
trueif this attribute set contains no attributes
-
equals
Compares the specified object with this attribute set for equality. Returnstrueif the given object is also an attribute set and the two attribute sets contain the same attribute category-attribute value mappings. This ensures that theequals()method works properly across different implementations of theAttributeSetinterface.- Specified by:
equalsin interfaceAttributeSet- Overrides:
equalsin classObject- Parameters:
object- to be compared for equality with this attribute set- Returns:
trueif the specified object is equal to this attribute set- See Also:
-
hashCode
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 theAttributeSet. This ensures thatt1.equals(t2)implies thatt1.hashCode()==t2.hashCode()for any two attribute setst1andt2, as required by the general contract ofObject.hashCode().- Specified by:
hashCodein interfaceAttributeSet- Overrides:
hashCodein classObject- Returns:
- the hash code value for this attribute set
- See Also:
-