javax.print.attribute

## Class HashAttributeSet

- 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 an `AttributeSet` 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.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### 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 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. If null, an empty attribute set is constructed.
      Throws:
        `NullPointerException` - (unchecked exception) Thrown if any element of `attributes` 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 interface `Attribute` 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 interface `Attribute` or a subinterface thereof.
      Throws:
        `NullPointerException` - (unchecked exception) Thrown if `attribute` is null.
        `NullPointerException` - if interfaceName is null.
        `ClassCastException` - (unchecked exception) Thrown if `attribute` is not an instance of `interfaceName`.

    - #### 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. 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 interface `Attribute` or a subinterface thereof.
      Throws:
        `NullPointerException` - (unchecked exception) Thrown if any element of `attributes` is null.
        `NullPointerException` - if interfaceName is null.
        `ClassCastException` - (unchecked exception) Thrown 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. 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 interface `Attribute` or a subinterface thereof.
      Throws:
        `ClassCastException` - (unchecked exception) Thrown if any element of `attributes` is not an instance of `interfaceName`.

  - ### 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 interface `AttributeSet`
      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` - (unchecked exception) Thrown if the `category` is null.
        `ClassCastException` - (unchecked exception) Thrown if the `category` is not a `Class` that implements interface `Attribute`.

    - #### 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 interface `AttributeSet`
      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 the `attribute` is null.
        `UnmodifiableSetException` - (unchecked exception) Thrown 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` in interface `AttributeSet`
      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 the `remove()` operation.

    - #### remove

          public boolean remove(Attribute attribute)

      Removes the specified attribute from this attribute set if present. If `attribute` is null, then `remove()` does nothing and returns `false`.
      Specified by:
        `remove` in interface `AttributeSet`
      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 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` in interface `AttributeSet`
      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 interface `AttributeSet`
      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 ``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.

      Specified by:
        `addAll` in interface `AttributeSet`
      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 interface `AttributeSet`
      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 interface `AttributeSet`
      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 interface `AttributeSet`
      Throws:
        `UnmodifiableSetException` - (unchecked exception) Thrown 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` in interface `AttributeSet`
      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 interface `AttributeSet`
      Overrides:
        `equals` in class `Object`
      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()`, `Hashtable`

    - #### 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 interface `AttributeSet`
      Overrides:
        `hashCode` in class `Object`
      Returns:
        The hash code value for this attribute set.
      See Also:
        `Object.equals(java.lang.Object)`, `Hashtable`

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.