HashAttributeSet (Java SE 15 & JDK 15) (original) (raw)

All Implemented Interfaces:

[Serializable](../../../../java.base/java/io/Serializable.html "interface in java.io"), [AttributeSet](AttributeSet.html "interface in javax.print.attribute")

Direct Known Subclasses:

[HashDocAttributeSet](HashDocAttributeSet.html "class in javax.print.attribute"), [HashPrintJobAttributeSet](HashPrintJobAttributeSet.html "class in javax.print.attribute"), [HashPrintRequestAttributeSet](HashPrintRequestAttributeSet.html "class in javax.print.attribute"), [HashPrintServiceAttributeSet](HashPrintServiceAttributeSet.html "class in javax.print.attribute")

public class HashAttributeSet extends Object implements AttributeSet, Serializable

Class HashAttributeSet provides an AttributeSet implementation with characteristics of a hash map.

See Also:

Serialized Form

• Constructor Summary

Constructors

• Method Summary

• Constructor Details

  • 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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if attribute 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 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.
  Throws:
  [NullPointerException](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if any element of attributes isnull

  • 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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - 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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if attribute orinterfaceName are null
[ClassCastException](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if attribute 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 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.
  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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if interfaceName is null, or if any element of attributes is null
[ClassCastException](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if any element of attributes is not an instance of interfaceName

  • 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. 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](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if any element of attributes is not an instance of interfaceName

• Method Details

  • get

  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](AttributeSet.html#get%28java.lang.Class%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  Parameters:
  category - attribute category whose associated attribute value is to be returned. It must be a Class that implements interface Attribute.
  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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if the category is null
[ClassCastException](../../../../java.base/java/lang/ClassCastException.html "class in java.lang") - if the category 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](AttributeSet.html#add%28javax.print.attribute.Attribute%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if the attribute is null
[UnmodifiableSetException](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the add() operation

  • remove

  public boolean remove​(Class<?> category)
  Removes any attribute for this category from this attribute set if present. If category is null, then remove() does nothing and returns false.
  Specified by:
  [remove](AttributeSet.html#remove%28java.lang.Class%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the remove() operation

  • remove

  public boolean remove​(Attribute attribute)
  Removes the specified attribute from this attribute set if present. Ifattribute is null, then remove() does nothing and returns false.
  Specified by:
  [remove](AttributeSet.html#remove%28javax.print.attribute.Attribute%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the remove() operation

  • containsKey

  public boolean containsKey​(Class<?> category)
  Returns true if this attribute set contains an attribute for the specified category.
  Specified by:
  [containsKey](AttributeSet.html#containsKey%28java.lang.Class%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](AttributeSet.html#containsValue%28javax.print.attribute.Attribute%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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 the add(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](AttributeSet.html#addAll%28javax.print.attribute.AttributeSet%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the addAll(AttributeSet) method
  [NullPointerException](../../../../java.base/java/lang/NullPointerException.html "class in java.lang") - if some element in the specified set isnull, 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, returnsInteger.MAX_VALUE.
  Specified by:
  [size](AttributeSet.html#size%28%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  Returns:
  the number of attributes in this attribute set

  • toArray

  Returns an array of the attributes contained in this set.
  Specified by:
  [toArray](AttributeSet.html#toArray%28%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](AttributeSet.html#clear%28%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  Throws:
  [UnmodifiableSetException](UnmodifiableSetException.html "class in javax.print.attribute") - if this attribute set does not support the clear() operation

  • isEmpty

  public boolean isEmpty()
  Returns true if this attribute set contains no attributes.
  Specified by:
  [isEmpty](AttributeSet.html#isEmpty%28%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  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](AttributeSet.html#equals%28java.lang.Object%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  Overrides:
  [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../../../java.base/java/lang/Object.html "class in java.lang")
  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 setst1 and t2, as required by the general contract ofObject.hashCode().
  Specified by:
  [hashCode](AttributeSet.html#hashCode%28%29) in interface [AttributeSet](AttributeSet.html "interface in javax.print.attribute")
  Overrides:
  [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29) in class [Object](../../../../java.base/java/lang/Object.html "class in java.lang")
  Returns:
  the hash code value for this attribute set
  See Also:
  Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)