|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeSet
AttributeSet
is the top-level interface for sets of printing
attributes in the Java Print Service API.
There are no duplicate values allowed in an attribute set and there is
at most one attribute object contained per category type. Based on the
Map
interface the values of attribute sets are objects
of type Attribute
and the entries are the
categories as Class
instances.
The following specialized types of AttributeSet
are available:
Attribute sets may be unmodifiable depending on the context of usage. If
used as read-only attribute set modifying operations throw an
UnmodifiableSetException
.
The Java Print Service API provides implementation classes for the existing attribute set interfaces but applications may use their own implementations.
Method Summary | |
---|---|
boolean |
add(Attribute attribute)
Adds the specified attribute value to this attribute set if it is not already present. |
boolean |
addAll(AttributeSet attributes)
Adds all of the elements in the specified set to this attribute set. |
void |
clear()
Removes all attributes from this attribute set. |
boolean |
containsKey(Class<?> category)
Checks if this attributes set contains an attribute with the given category. |
boolean |
containsValue(Attribute attribute)
Checks if this attribute set contains the given attribute. |
boolean |
equals(Object obj)
Tests this set for equality with the given object. |
Attribute |
get(Class<?> category)
Returns the attribute object contained in this set for the given attribute category. |
int |
hashCode()
Returns the hashcode value. |
boolean |
isEmpty()
Checks if the attribute set is empty. |
boolean |
remove(Attribute attribute)
Removes the given attribute from the set. |
boolean |
remove(Class<?> category)
Removes the attribute entry of the given category from the set. |
int |
size()
Returns the number of elements in this attribute set. |
Attribute[] |
toArray()
Returns the content of the attribute set as an array |
Method Detail |
---|
boolean add(Attribute attribute)
attribute
- the attribute to add.
true
if the set is changed, false otherwise.
NullPointerException
- if the attribute is null
.
UnmodifiableSetException
- if the set does not support modification.boolean addAll(AttributeSet attributes)
attributes
- the set of attributes to add.
true
if the set is changed, false otherwise.
UnmodifiableSetException
- if the set does not support modification.add(Attribute)
void clear()
UnmodifiableSetException
- if the set does not support modification.boolean containsKey(Class<?> category)
category
- the category to test for.
true
if an attribute of the category is contained
in the set, false
otherwise.boolean containsValue(Attribute attribute)
attribute
- the attribute to test for.
true
if the attribute is contained in the set,
false
otherwise.boolean equals(Object obj)
true
is
returned, if the given object is also of type AttributeSet
and the contained attributes are the same as in this set.
equals
in class Object
obj
- the Object to test.
true
if equal, false otherwise.Object.hashCode()
Attribute get(Class<?> category)
category
- the category of the attribute. A Class
instance of a class implementing the Attribute
interface.
null
if no
attribute is contained for the given category.
NullPointerException
- if category is null.
ClassCastException
- if category is not implementing
Attribute
.int hashCode()
hashCode
in class Object
Object.equals(Object)
,
System.identityHashCode(Object)
boolean isEmpty()
true
if the attribute set is empty, false otherwise.boolean remove(Attribute attribute)
null
nothing is done and false
is returned.
attribute
- the attribute to remove.
true
if removed, false in all other cases.
UnmodifiableSetException
- if the set does not support modification.boolean remove(Class<?> category)
null
nothing is done and false
is returned.
category
- the category of the entry to be removed.
true
if an attribute is removed, false in all other cases.
UnmodifiableSetException
- if the set does not support modification.int size()
Attribute[] toArray()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |