| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeSet
Interface AttributeSet specifies the interface for a set of printing attributes. A printing attribute is an object whose class implements interface {@link Attribute 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 {@link
Attribute Attribute} objects, and the categories are {@link java.lang.Class
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 {@link Attribute#getCategory()
getCategory()
} method defined in interface {@link Attribute
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 -- {@link DocAttribute DocAttribute}, {@link PrintRequestAttribute PrintRequestAttribute}, {@link PrintJobAttribute PrintJobAttribute}, and {@link PrintServiceAttribute PrintServiceAttribute}. There are four specializations of an attribute set that are restricted to contain just one of the four kinds of attribute -- {@link DocAttributeSet DocAttributeSet}, {@link PrintRequestAttributeSet PrintRequestAttributeSet}, {@link PrintJobAttributeSet PrintJobAttributeSet}, and {@link PrintServiceAttributeSet PrintServiceAttributeSet}, respectively. Note that many attribute classes implement more than one tagging interface and so may appear in more than one context.
In some contexts, the client is only allowed to examine an attribute set's contents but not change them (the set is read-only). In other places, the client is allowed both to examine and to change an attribute set's contents (the set is read-write). For a read-only attribute set, calling a mutating operation throws an UnmodifiableSetException.
The Print Service API provides one implementation of interface AttributeSet, class {@link HashAttributeSet HashAttributeSet}. A client can use class {@link HashAttributeSet HashAttributeSet} or provide its own implementation of interface AttributeSet. The Print Service API also provides implementations of interface AttributeSet's subinterfaces -- classes {@link HashDocAttributeSet HashDocAttributeSet}, {@link HashPrintRequestAttributeSet HashPrintRequestAttributeSet}, {@link HashPrintJobAttributeSet HashPrintJobAttributeSet}, and {@link HashPrintServiceAttributeSet HashPrintServiceAttributeSet}.
Method Summary | |
---|---|
boolean |
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. |
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 value. |
boolean |
Compares the specified object with this attribute set for equality. |
Attribute |
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 |
Removes the specified attribute from this attribute set if present. |
boolean |
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. |
Method Detail |
---|
public boolean add(Attribute attribute)
attribute
- Attribute value to be added to this attribute set.public boolean addAll(AttributeSet attributes)
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.
attributes
- whose elements are to be added to this attribute
set.public void clear()
public boolean containsKey(Class category)
category
- whose presence in this attribute set is
to be tested.public boolean containsValue(Attribute attribute)
attribute
- Attribute value whose presence in this
attribute set is to be tested.public boolean equals(Object object)
equals
in class Object
object
- to be compared for equality with this attribute set.public Attribute get(Class category)
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}.public int hashCode()
Object.hashCode()
}.
hashCode
in class Object
public boolean isEmpty()
public boolean remove(Attribute attribute)
attribute
is null, then
remove()
does nothing and returns false.
attribute
- Attribute value to be removed from this attribute set.public boolean remove(Class category)
category
is null, then
remove()
does nothing and returns false.
category
- Attribute category to be removed from this
attribute set.public int size()
public Attribute[] toArray()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |