FileDocCategorySizeDatePackage
HashAttributeSet.javaAPI DocJava SE 5 API18256Fri Aug 26 14:57:42 BST 2005javax.print.attribute

HashAttributeSet

public class HashAttributeSet extends Object implements Serializable, AttributeSet
Class HashAttributeSet provides an AttributeSet implementation with characteristics of a hash map.

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
private Class
myInterface
The interface of which all members of this attribute set must be an instance. It is assumed to be interface {@link Attribute Attribute} or a subinterface thereof.
private transient HashMap
attrMap
Constructors Summary
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.

param
attributes set of attribute values to initialise the set. If null, an empty attribute set is constructed.
param
interfaceName The interface of which all members of this attribute set must be an instance. It is assumed to be interface {@link Attribute Attribute} or a subinterface thereof.
exception
ClassCastException (unchecked exception) Thrown if any element of attributes is not an instance of interfaceName.

      myInterface = interfaceName;
      if (attributes != null) {
	Attribute[] attribArray = attributes.toArray();	    
	int n = attribArray == null ? 0 : attribArray.length;
	for (int i = 0; i < n; ++ i) {
	  add (attribArray[i]);
	}
      }
    
public HashAttributeSet()
Construct a new, empty attribute set.

	this(Attribute.class);
    
public HashAttributeSet(Attribute attribute)
Construct a new attribute set, initially populated with the given attribute.

param
attribute Attribute value to add to the set.
exception
NullPointerException (unchecked exception) Thrown if attribute is null.

	this (attribute, Attribute.class);
    
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.

param
attributes Array of attribute values to add to the set. If null, an empty attribute set is constructed.
exception
NullPointerException (unchecked exception) Thrown if any element of attributes is null.

	this (attributes, Attribute.class);
    
public HashAttributeSet(AttributeSet attributes)
Construct a new attribute set, initially populated with the values from the given set.

param
attributes Set of attributes from which to initialise this set. If null, an empty attribute set is constructed.

	this (attributes, Attribute.class);
    
protected HashAttributeSet(Class interfaceName)
Construct a new, empty attribute set, where the members of the attribute set are restricted to the given interface.

param
interfaceName The interface of which all members of this attribute set must be an instance. It is assumed to be interface {@link Attribute Attribute} or a subinterface thereof.
exception
NullPointerException if interfaceName is null.

	if (interfaceName == null) {
	    throw new NullPointerException("null interface");
	}
	myInterface = interfaceName;
    
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.

param
attribute Attribute value to add to the set.
param
interfaceName The interface of which all members of this attribute set must be an instance. It is assumed to be interface {@link Attribute Attribute} or a subinterface thereof.
exception
NullPointerException (unchecked exception) Thrown if attribute is null.
exception
NullPointerException if interfaceName is null.
exception
ClassCastException (unchecked exception) Thrown if attribute is not an instance of interfaceName.

	if (interfaceName == null) {
	    throw new NullPointerException("null interface");
	}
	myInterface = interfaceName;
	add (attribute);
    
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.

param
attributes Array of attribute values to add to the set. If null, an empty attribute set is constructed.
param
interfaceName The interface of which all members of this attribute set must be an instance. It is assumed to be interface {@link Attribute Attribute} or a subinterface thereof.
exception
NullPointerException (unchecked exception) Thrown if any element of attributes is null.
exception
NullPointerException if interfaceName is null.
exception
ClassCastException (unchecked exception) Thrown if any element of attributes is not an instance of interfaceName.

	if (interfaceName == null) {
	    throw new NullPointerException("null interface");
	}
	myInterface = interfaceName;
	int n = attributes == null ? 0 : attributes.length;
	for (int i = 0; i < n; ++ i) {
	    add (attributes[i]);
	}
    
Methods Summary
public booleanadd(javax.print.attribute.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.

param
attribute Attribute value to be added to this attribute set.
return
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.
throws
UnmodifiableSetException (unchecked exception) Thrown if this attribute set does not support the add() operation.

	Object oldAttribute = 
	    attrMap.put(attribute.getCategory(),
			AttributeSetUtilities.
			verifyAttributeValue(attribute, myInterface));
	return (!attribute.equals(oldAttribute));
    
public booleanaddAll(javax.print.attribute.AttributeSet attributes)
Adds all of the elements in the specified set to this attribute. The outcome is the same as if the {@link #add(Attribute) 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.

param
attributes whose elements are to be added to this attribute set.
return
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.
throws
NullPointerException (Unchecked exception) Thrown if some element in the specified set is null, or the set is null.
see
#add(Attribute)

	
	Attribute []attrs = attributes.toArray();
	boolean result = false;
	for (int i=0; i<attrs.length; i++) {
	    Attribute newValue =
		AttributeSetUtilities.verifyAttributeValue(attrs[i], 
							   myInterface);
	    Object oldValue = attrMap.put(newValue.getCategory(), newValue);
	    result = (! newValue.equals(oldValue)) || result;
	}
	return result;
    
public voidclear()
Removes all attributes from this attribute set.

throws
UnmodifiableSetException (unchecked exception) Thrown if this attribute set does not support the clear() operation.

	attrMap.clear();
    
public booleancontainsKey(java.lang.Class category)
Returns true if this attribute set contains an attribute for the specified category.

param
category whose presence in this attribute set is to be tested.
return
true if this attribute set contains an attribute value for the specified category.

	return
	    category != null &&
	    AttributeSetUtilities.
	    verifyAttributeCategory(category, Attribute.class) != null &&
	    attrMap.get(category) != null;
    
public booleancontainsValue(javax.print.attribute.Attribute attribute)
Returns true if this attribute set contains the given attribute.

param
attribute value whose presence in this attribute set is to be tested.
return
true if this attribute set contains the given attribute value.

	return
	   attribute != null &&
	   attribute instanceof Attribute &&
	   attribute.equals(attrMap.get(((Attribute)attribute).getCategory()));
    
public booleanequals(java.lang.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.

param
object to be compared for equality with this attribute set.
return
true if the specified object is equal to this attribute set.

	if (object == null || !(object instanceof AttributeSet)) {
	    return false;
	}

	AttributeSet aset = (AttributeSet)object;
	if (aset.size() != size()) {
	    return false;
	}

	Attribute[] attrs = toArray();    
	for (int i=0;i<attrs.length; i++) {
	    if (!aset.containsValue(attrs[i])) {
		return false;
	    }
	}
	return true;
    
public javax.print.attribute.Attributeget(java.lang.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.

param
category Attribute category whose associated attribute value is to be returned. It must be a {@link java.lang.Class Class} that implements interface {@link Attribute Attribute}.
return
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.
throws
ClassCastException (unchecked exception) Thrown if the category is not a {@link java.lang.Class Class} that implements interface {@link Attribute Attribute}.

	return (Attribute)
	    attrMap.get(AttributeSetUtilities.
			verifyAttributeCategory(category,
						Attribute.class));
    
public inthashCode()
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 {@link java.lang.Object#hashCode() Object.hashCode()}.

return
The hash code value for this attribute set.

	int hcode = 0;
	Attribute[] attrs = toArray();    
	for (int i=0;i<attrs.length; i++) {
	    hcode += attrs[i].hashCode();
	}
	return hcode;
    
public booleanisEmpty()
Returns true if this attribute set contains no attributes.

return
true if this attribute set contains no attributes.

	return attrMap.isEmpty();
    
private voidreadObject(java.io.ObjectInputStream s)
Reconstitute an instance from a stream that is, deserialize it).

	
	s.defaultReadObject();
	attrMap = new HashMap();
	int count = s.readInt();
	Attribute attr;
	for (int i = 0; i < count; i++) {
	    attr = (Attribute)s.readObject();
	    add(attr);
	}	
    
public booleanremove(java.lang.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.

param
category Attribute category to be removed from this attribute set.
return
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.

	return
	    category != null &&
	    AttributeSetUtilities.
	    verifyAttributeCategory(category, Attribute.class) != null &&
	    attrMap.remove(category) != null;
    
public booleanremove(javax.print.attribute.Attribute attribute)
Removes the specified attribute from this attribute set if present. If attribute is null, then remove() does nothing and returns false.

param
attribute Attribute value to be removed from this attribute set.
return
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.

	return
	    attribute != null &&
	    attrMap.remove(attribute.getCategory()) != null;
    
public intsize()
Returns the number of attributes in this attribute set. If this attribute set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

return
The number of attributes in this attribute set.

	return attrMap.size();
    
public javax.print.attribute.Attribute[]toArray()

return
the Attributes contained in this set as an array, zero length if the AttributeSet is empty.

	Attribute []attrs = new Attribute[size()];
	attrMap.values().toArray(attrs);
	return attrs;
    
private voidwriteObject(java.io.ObjectOutputStream s)
Write the instance to a stream (ie serialize the object)

serialData
The serialized form of an attribute set explicitly writes the number of attributes in the set, and each of the attributes. This does not guarantee equality of serialized forms since the order in which the attributes are written is not defined.


                                                             
          

	s.defaultWriteObject();
	Attribute [] attrs = toArray();
	s.writeInt(attrs.length);
	for (int i = 0; i < attrs.length; i++) {
	    s.writeObject(attrs[i]);
	}