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
ModifierConstructorDescriptionConstruct a new, empty attribute set.protected
HashAttributeSet
(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.protected
HashAttributeSet
(Attribute[] attributes, Class<?> interfaceName) Construct a new 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.HashAttributeSet
(AttributeSet attributes) Construct a new attribute set, initially populated with the values from the given set.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. -
Method Summary
Modifier and TypeMethodDescriptionboolean
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.boolean
addAll
(AttributeSet attributes) Adds all of the elements in the specified set to this attribute.void
clear()
Removes all attributes from this attribute set.boolean
containsKey
(Class<?> category) Returnstrue
if this attribute set contains an attribute for the specified category.boolean
containsValue
(Attribute attribute) Returnstrue
if this attribute set contains the given attribute.boolean
Compares the specified object with this attribute set for equality.Returns the attribute value which this attribute set contains in the given attribute category.int
hashCode()
Returns the hash code value for this attribute set.boolean
isEmpty()
Returnstrue
if this attribute set contains no attributes.boolean
Removes any attribute for this category from this attribute set if present.boolean
Removes the specified attribute from this attribute set if present.int
size()
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
- ifattribute
isnull
-
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 ofattributes
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.- Throws:
NullPointerException
- if any element ofattributes
isnull
-
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 interfaceAttribute
or a subinterface thereof.- Throws:
NullPointerException
- ifinterfaceName
isnull
-
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 interfaceAttribute
or a subinterface thereof.- Throws:
NullPointerException
- ifattribute
orinterfaceName
arenull
ClassCastException
- ifattribute
is 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 ofattributes
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.interfaceName
- the interface of which all members of this attribute set must be an instance. It is assumed to be interfaceAttribute
or a subinterface thereof.- Throws:
NullPointerException
- ifinterfaceName
isnull
, or if any element ofattributes
isnull
ClassCastException
- if any element ofattributes
is 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 interfaceAttribute
or a subinterface thereof.- Throws:
ClassCastException
- if any element ofattributes
is not an instance ofinterfaceName
-
-
Method Details
-
get
Returns the attribute value which this attribute set contains in the given attribute category. Returnsnull
if this attribute set does not contain any attribute value in the given attribute category.- Specified by:
get
in interfaceAttributeSet
- Parameters:
category
- attribute category whose associated attribute value is to be returned. It must be aClass
that implements interfaceAttribute
.- 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 - Throws:
NullPointerException
- if thecategory
isnull
ClassCastException
- if thecategory
is not aClass
that 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:
add
in interfaceAttributeSet
- Parameters:
attribute
- attribute value to be added to this attribute set- 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- Throws:
NullPointerException
- if theattribute
isnull
UnmodifiableSetException
- if this attribute set does not support theadd()
operation
-
remove
Removes any attribute for this category from this attribute set if present. Ifcategory
isnull
, thenremove()
does nothing and returnsfalse
.- Specified by:
remove
in interfaceAttributeSet
- Parameters:
category
- attribute category to be removed from this attribute set- Returns:
true
if 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. Ifattribute
isnull
, thenremove()
does nothing and returnsfalse
.- Specified by:
remove
in interfaceAttributeSet
- Parameters:
attribute
- attribute value to be removed from this attribute set- 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- Throws:
UnmodifiableSetException
- if this attribute set does not support theremove()
operation
-
containsKey
Returnstrue
if this attribute set contains an attribute for the specified category.- Specified by:
containsKey
in interfaceAttributeSet
- Parameters:
category
- whose presence in this attribute set is to be tested- Returns:
true
if this attribute set contains an attribute value for the specified category
-
containsValue
Returnstrue
if this attribute set contains the given attribute.- Specified by:
containsValue
in interfaceAttributeSet
- Parameters:
attribute
- value whose presence in this attribute set is to be tested- Returns:
true
if 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:
addAll
in interfaceAttributeSet
- Parameters:
attributes
- whose elements are to be added to this attribute set- Returns:
true
if 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_VALUE
elements, returnsInteger.MAX_VALUE
.- Specified by:
size
in interfaceAttributeSet
- Returns:
- the number of attributes in this attribute set
-
toArray
Returns an array of the attributes contained in this set.- Specified by:
toArray
in interfaceAttributeSet
- Returns:
- the attributes contained in this set as an array, zero length if
the
AttributeSet
is empty
-
clear
public void clear()Removes all attributes from this attribute set.- Specified by:
clear
in interfaceAttributeSet
- Throws:
UnmodifiableSetException
- if this attribute set does not support theclear()
operation
-
isEmpty
public boolean isEmpty()Returnstrue
if this attribute set contains no attributes.- Specified by:
isEmpty
in interfaceAttributeSet
- Returns:
true
if this attribute set contains no attributes
-
equals
Compares the specified object with this attribute set for equality. Returnstrue
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 theequals()
method works properly across different implementations of theAttributeSet
interface.- Specified by:
equals
in interfaceAttributeSet
- Overrides:
equals
in classObject
- Parameters:
object
- to be compared for equality with this attribute set- Returns:
true
if 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 setst1
andt2
, as required by the general contract ofObject.hashCode()
.- Specified by:
hashCode
in interfaceAttributeSet
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this attribute set
- See Also:
-