- All Known Subinterfaces:
DocAttributeSet,PrintJobAttributeSet,PrintRequestAttributeSet,PrintServiceAttributeSet
- All Known Implementing Classes:
HashAttributeSet,HashDocAttributeSet,HashPrintJobAttributeSet,HashPrintRequestAttributeSet,HashPrintServiceAttributeSet
AttributeSet specifies the interface for a set of printing
attributes. A printing attribute is an object whose class implements
interface Attribute.
An attribute set contains a group of attribute values, where duplicate
values are not allowed in the set. Furthermore, each value in an attribute
set is a member of some category, and at most one value in any
particular category is allowed in the set. For an attribute set, the values
are Attribute objects, and the categories are
Class objects. An attribute's category is the class (or
interface) at the root of the class hierarchy for that kind of attribute.
Note that an attribute object's category may be a superclass of the attribute
object's class rather than the attribute object's class itself. An attribute
object's category is determined by calling the
getCategory() method defined in interface
Attribute.
The interfaces of an AttributeSet resemble those of the Java
Collections API's java.util.Map interface, but is more restrictive in
the types it will accept, and combines keys and values into an
Attribute.
Attribute sets are used in several places in the Print Service API. In each
context, only certain kinds of attributes are allowed to appear in the
attribute set, as determined by the tagging interfaces which the attribute
class implements -- DocAttribute,
PrintRequestAttribute,
PrintJobAttribute, and
PrintServiceAttribute.
There are four specializations of an attribute set that are restricted to
contain just one of the four kinds of attribute --
DocAttributeSet,
PrintRequestAttributeSet,
PrintJobAttributeSet, and
PrintServiceAttributeSet, respectively. Note
that many attribute classes implement more than one tagging interface and so
may appear in more than one context.
- A
DocAttributeSet, containingDocAttributes, specifies the characteristics of an individual doc and the print job settings to be applied to an individual doc. - A
PrintRequestAttributeSet, containingPrintRequestAttributes, specifies the settings to be applied to a whole print job and to all the docs in the print job. - A
PrintJobAttributeSet, containingPrintJobAttributes, reports the status of a print job. - A
PrintServiceAttributeSet, containingPrintServiceAttributes, reports the status of a Print Service instance.
UnmodifiableSetException.
The Print Service API provides one implementation of interface
AttributeSet, class HashAttributeSet. A
client can use class HashAttributeSet or provide its
own implementation of interface AttributeSet. The Print Service API
also provides implementations of interface AttributeSet's
subinterfaces -- classes
HashDocAttributeSet,
HashPrintRequestAttributeSet,
HashPrintJobAttributeSet, and
HashPrintServiceAttributeSet.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds the specified attribute to this attribute set if it is not already present, first removing any existing value in the same attribute category as the specified attribute value.booleanaddAll(AttributeSet attributes) Adds all of the elements in the specified set to this attribute.voidclear()Removes all attributes from this attribute set.booleancontainsKey(Class<?> category) Returnstrueif this attribute set contains an attribute for the specified category.booleancontainsValue(Attribute attribute) Returnstrueif this attribute set contains the given attribute value.booleanCompares the specified object with this attribute set for equality.Returns the attribute value which this attribute set contains in the given attribute category.inthashCode()Returns the hash code value for this attribute set.booleanisEmpty()Returnstrueif this attribute set contains no attributes.booleanRemoves any attribute for this category from this attribute set if present.booleanRemoves the specified attribute from this attribute set if present.intsize()Returns the number of attributes in this attribute set.toArray()Returns an array of the attributes contained in this set.
-
Method Details
-
get
Returns the attribute value which this attribute set contains in the given attribute category. Returnsnullif this attribute set does not contain any attribute value in the given attribute category.- Parameters:
category- attribute category whose associated attribute value is to be returned. It must be aClassthat implements interfaceAttribute.- Returns:
- the attribute value in the given attribute category contained in
this attribute set, or
nullif this attribute set does not contain any attribute value in the given attribute category - Throws:
NullPointerException- if thecategoryisnullClassCastException- if thecategoryis not aClassthat implements interfaceAttribute
-
add
Adds the specified attribute to this attribute set if it is not already present, first removing any existing value in the same attribute category as the specified attribute value.- Parameters:
attribute- attribute value to be added to this attribute set- Returns:
trueif 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 theattributeisnullUnmodifiableSetException- if this attribute set does not support theadd()operation
-
remove
Removes any attribute for this category from this attribute set if present. Ifcategoryisnull, thenremove()does nothing and returnsfalse.- Parameters:
category- attribute category to be removed from this attribute set- Returns:
trueif 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
-
remove
Removes the specified attribute from this attribute set if present. Ifattributeisnull, thenremove()does nothing and returnsfalse.- Parameters:
attribute- attribute value to be removed from this attribute set- Returns:
trueif 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
Returnstrueif this attribute set contains an attribute for the specified category.- Parameters:
category- whose presence in this attribute set is to be tested- Returns:
trueif this attribute set contains an attribute value for the specified category
-
containsValue
Returnstrueif this attribute set contains the given attribute value.- Parameters:
attribute- attribute value whose presence in this attribute set is to be tested- Returns:
trueif 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.- Parameters:
attributes- whose elements are to be added to this attribute set- Returns:
trueif 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- See Also:
-
size
int size()Returns the number of attributes in this attribute set. If this attribute set contains more thanInteger.MAX_VALUEelements, returnsInteger.MAX_VALUE.- Returns:
- the number of attributes in this attribute set
-
toArray
Attribute[] toArray()Returns an array of the attributes contained in this set.- Returns:
- the
Attributescontained in this set as an array, zero length if theAttributeSetis empty
-
clear
void clear()Removes all attributes from this attribute set.- Throws:
UnmodifiableSetException- if this attribute set does not support theclear()operation
-
isEmpty
boolean isEmpty()Returnstrueif this attribute set contains no attributes.- Returns:
trueif this attribute set contains no attributes
-
equals
Compares the specified object with this attribute set for equality. Returnstrueif 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 theAttributeSetinterface. -
hashCode
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 setst1andt2, as required by the general contract ofObject.hashCode().
-