javax.print.attribute
Interface AttributeSet
- DocAttributeSet, PrintJobAttributeSet, PrintRequestAttributeSet, PrintServiceAttributeSet
- HashAttributeSet, HashDocAttributeSet, HashPrintJobAttributeSet, HashPrintRequestAttributeSet, HashPrintServiceAttributeSet
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.
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(Class category)- Removes the attribute entry of the given category from the set.
|
boolean | remove(Attribute attribute)- Removes the given attribute 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
|
add
public boolean add(Attribute attribute)
Adds the specified attribute value to this attribute set
if it is not already present.
This operation removes any existing attribute of the same category
before adding the given attribute to the set.
attribute - the attribute to add.
true if the set is changed, false otherwise.
addAll
public boolean addAll(AttributeSet attributes)
Adds all of the elements in the specified set to this attribute set.
attributes - the set of attributes to add.
true if the set is changed, false otherwise.
clear
public void clear()
Removes all attributes from this attribute set.
containsKey
public boolean containsKey(Class category)
Checks if this attributes set contains an attribute with the given
category.
category - the category to test for.
true if an attribute of the category is contained
in the set, false otherwise.
containsValue
public boolean containsValue(Attribute attribute)
Checks if this attribute set contains the given attribute.
attribute - the attribute to test for.
true if the attribute is contained in the set,
false otherwise.
equals
public boolean equals(Object obj)
Tests this set for equality with the given object. 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 interface Object
obj - the Object to test.
true if equal, false otherwise.
get
public Attribute get(Class category)
Returns the attribute object contained in this set for the given attribute
category.
category - the category of the attribute. A Class
instance of a class implementing the Attribute interface.
- The attribute for this category or
null if no
attribute is contained for the given category.
hashCode
public int hashCode()
Returns the hashcode value. The hashcode value is the sum of all hashcodes
of the attributes contained in this set.
- hashCode in interface Object
- The hashcode for this attribute set.
isEmpty
public boolean isEmpty()
Checks if the attribute set is empty.
true if the attribute set is empty, false otherwise.
remove
public boolean remove(Class category)
Removes the attribute entry of the given category from the set. If the given
category is 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.
remove
public boolean remove(Attribute attribute)
Removes the given attribute from the set. If the given attribute is null
nothing is done and false is returned.
attribute - the attribute to remove.
true if removed, false in all other cases.
size
public int size()
Returns the number of elements in this attribute set.
toArray
public Attribute[] toArray()
Returns the content of the attribute set as an array
AttributeSet.java --
Copyright (C) 2002, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.