- java.lang.Object
-
- javax.print.attribute.HashAttributeSet
-
- All Implemented Interfaces:
- Serializable, AttributeSet
- Direct Known Subclasses:
- HashDocAttributeSet, HashPrintJobAttributeSet, HashPrintRequestAttributeSet, HashPrintServiceAttributeSet
public class HashAttributeSet extends Object implements AttributeSet, Serializable
Class HashAttributeSet provides anAttributeSet
implementation with characteristics of a hash map.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor and Description HashAttributeSet()
Construct a new, empty attribute set.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.protected
HashAttributeSet(Class<?> interfaceName)
Construct a new, empty attribute set, where the members of the attribute set are restricted to the given interface.
-
Method Summary
Methods Modifier and Type Method and Description 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.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)
Returns true if this attribute set contains an attribute for the specified category.boolean
containsValue(Attribute attribute)
Returns true if this attribute set contains the given attribute.boolean
equals(Object object)
Compares the specified object with this attribute set for equality.Attribute
get(Class<?> category)
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()
Returns true if this attribute set contains no attributes.boolean
remove(Attribute attribute)
Removes the specified attribute from this attribute set if present.boolean
remove(Class<?> category)
Removes any attribute for this category from this attribute set if present.int
size()
Returns the number of attributes in this attribute set.Attribute[]
toArray()
Returns an array of the attributes contained in this set.
-
-
-
Constructor Detail
-
HashAttributeSet
public HashAttributeSet()
Construct a new, empty attribute set.
-
HashAttributeSet
public HashAttributeSet(Attribute attribute)
Construct a new attribute set, initially populated with the given attribute.- Parameters:
attribute
- Attribute value to add to the set.- Throws:
NullPointerException
- (unchecked exception) Thrown ifattribute
is null.
-
HashAttributeSet
public HashAttributeSet(Attribute[] attributes)
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. If null, an empty attribute set is constructed.- Throws:
NullPointerException
- (unchecked exception) Thrown if any element ofattributes
is null.
-
HashAttributeSet
public HashAttributeSet(AttributeSet attributes)
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)
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
- if interfaceName is null.
-
HashAttributeSet
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.- Parameters:
attribute
- Attribute value to add to the set.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
- (unchecked exception) Thrown ifattribute
is null.NullPointerException
- if interfaceName is null.ClassCastException
- (unchecked exception) Thrown ifattribute
is not an instance ofinterfaceName
.
-
HashAttributeSet
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 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. If null, 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
- (unchecked exception) Thrown if any element ofattributes
is null.NullPointerException
- if interfaceName is null.ClassCastException
- (unchecked exception) Thrown if any element ofattributes
is not an instance ofinterfaceName
.
-
HashAttributeSet
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. If null, 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
- (unchecked exception) Thrown if any element ofattributes
is not an instance ofinterfaceName
.
-
-
Method Detail
-
get
public Attribute get(Class<?> category)
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.- 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
- (unchecked exception) Thrown if thecategory
is null.ClassCastException
- (unchecked exception) Thrown if thecategory
is not aClass
that implements interfaceAttribute
.
-
add
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.- 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
- (unchecked exception) Thrown if theattribute
is null.UnmodifiableSetException
- (unchecked exception) Thrown if this attribute set does not support theadd()
operation.
-
remove
public boolean remove(Class<?> category)
Removes any attribute for this category from this attribute set if present. Ifcategory
is null, thenremove()
does nothing and returns false.- 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
- (unchecked exception) Thrown if this attribute set does not support theremove()
operation.
-
remove
public boolean remove(Attribute attribute)
Removes the specified attribute from this attribute set if present. Ifattribute
is null, thenremove()
does nothing and returns false.- 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
- (unchecked exception) Thrown if this attribute set does not support theremove()
operation.
-
containsKey
public boolean containsKey(Class<?> category)
Returns true 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
public boolean containsValue(Attribute attribute)
Returns true 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
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
operation had been applied to this attribute set successively with each element from the specified set. The behavior of theadd(Attribute)
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.- 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
- (Unchecked exception) Thrown if this attribute set does not support the addAll(AttributeSet) method.NullPointerException
- (Unchecked exception) Thrown if some element in the specified set is null, or the set is null.- See Also:
add(Attribute)
-
size
public int size()
Returns the number of attributes in this attribute set. If this attribute set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.- Specified by:
size
in interfaceAttributeSet
- Returns:
- The number of attributes in this attribute set.
-
toArray
public Attribute[] toArray()
Description copied from interface:AttributeSet
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
- (unchecked exception) Thrown if this attribute set does not support theclear()
operation.
-
isEmpty
public boolean isEmpty()
Returns true if this attribute set contains no attributes.- Specified by:
isEmpty
in interfaceAttributeSet
- Returns:
- true if this attribute set contains no attributes.
-
equals
public boolean equals(Object object)
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.- 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:
Object.hashCode()
,HashMap
-
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 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
.Object.hashCode()
- Specified by:
hashCode
in interfaceAttributeSet
- Overrides:
hashCode
in classObject
- Returns:
- The hash code value for this attribute set.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/print/attribute/hashattributeset.html/.html/
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.