Overview Package Class Use Source Tree Index Deprecated About

GNU Classpath (0.95)

Prev Class | Next Class Frames | No Frames

javax.swing.text

Class SimpleAttributeSet

java.lang.Object
- javax.swing.text.SimpleAttributeSet

Implemented Interfaces:: AttributeSet, Cloneable, MutableAttributeSet, Serializable

public class SimpleAttributeSet

extends Object

implements MutableAttributeSet, Serializable, Cloneable

A set of attributes.

See Also:: Serialized Form

Field Summary

static AttributeSet

EMPTY: An empty attribute set.

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Constructor Summary

SimpleAttributeSet(): Creates a new attribute set that is initially empty.

SimpleAttributeSet(AttributeSet a): Creates a new SimpleAttributeSet with the same attributes and resolve parent as the specified set.

Method Summary

void

addAttribute(Object name, Object value): Adds an attribute with the given name and value to the set.

void

addAttributes(AttributeSet attributes): Adds all the attributes from attributes to this set.

Object

clone(): Returns a clone of the attribute set.

boolean

containsAttribute(Object name, Object value): Returns true if the given name and value represent an attribute found either in this AttributeSet or in its resolve parent hierarchy.

boolean

containsAttributes(AttributeSet attributes): Returns true of this AttributeSet contains all of the specified attributes.

AttributeSet

copyAttributes(): Creates and returns a copy of this AttributeSet.

boolean

equals(Object obj): Checks this set for equality with an arbitrary object.

Object

getAttribute(Object name): Returns the value of the specified attribute, or null if there is no attribute with that name.

int

getAttributeCount(): Returns the number of attributes stored in this set, plus 1 if a parent has been specified (the reference to the parent is stored as a special attribute).

Enumeration

getAttributeNames(): Returns an enumeration of the attribute names.

AttributeSet

getResolveParent(): Returns the resolving parent.

int

hashCode(): Returns a hash code for this instance.

boolean

isDefined(Object attrName): Returns true if the given attribute is defined in this set, and false otherwise.

boolean

isEmpty(): Returns true if the set contains no attributes, and false otherwise.

boolean

isEqual(AttributeSet attr): Returns true if the given set has the same number of attributes as this set and containsAttributes(attr) returns true.

void

removeAttribute(Object name): Removes the attribute with the specified name, if this attribute is defined.

void

removeAttributes(Enumeration names): Removes the attributes listed in names.

void

removeAttributes(AttributeSet attributes): Removes attributes from this set if they are found in the given set.

void

setResolveParent(AttributeSet parent): Sets the reolving parent for this set.

String

toString(): Returns a string representation of this instance, typically used for debugging purposes.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY

public static final AttributeSet EMPTY

An empty attribute set.

Constructor Details

SimpleAttributeSet

public SimpleAttributeSet()

Creates a new attribute set that is initially empty.

SimpleAttributeSet

public SimpleAttributeSet(AttributeSet a)

Creates a new SimpleAttributeSet with the same attributes and resolve parent as the specified set.
Parameters:
a - the attributes (null not permitted).
Throws:
NullPointerException - if a is null.

Method Details

addAttribute

public void addAttribute(Object name,
 Object value)

Adds an attribute with the given name and value to the set. If the set already contains an attribute with the given name, the attribute value is updated.
Specified by:
addAttribute in interface MutableAttributeSet
Parameters:
name - the attribute name (null not permitted).
value - the value (null not permitted).
Throws:
NullPointerException - if either argument is null.

addAttributes

public void addAttributes(AttributeSet attributes)

Adds all the attributes from attributes to this set.
Specified by:
addAttributes in interface MutableAttributeSet
Parameters:
attributes - the set of attributes to add (null not permitted).
Throws:
NullPointerException - if attributes is null.

clone

public Object clone()

Returns a clone of the attribute set.
Overrides:
clone in interface Object
Returns:
A clone of the attribute set.

containsAttribute

public boolean containsAttribute(Object name,
 Object value)

Returns true if the given name and value represent an attribute found either in this AttributeSet or in its resolve parent hierarchy.
Specified by:
containsAttribute in interface AttributeSet
Parameters:
name - the key for the attribute
value - the value for the attribute
Returns:
true if the attribute is found here or in this set's resolve parent hierarchy

containsAttributes

public boolean containsAttributes(AttributeSet attributes)

Returns true of this AttributeSet contains all of the specified attributes.
Specified by:
containsAttributes in interface AttributeSet
Parameters:
attributes - the requested attributes
Returns:
true of this AttributeSet contains all of the specified attributes

copyAttributes

public AttributeSet copyAttributes()

Creates and returns a copy of this AttributeSet.
Specified by:
copyAttributes in interface AttributeSet
Returns:
a copy of this AttributeSet

equals

public boolean equals(Object obj)

Checks this set for equality with an arbitrary object.
Overrides:
equals in interface Object
Parameters:
obj - the object (null permitted).
Returns:
true if this set is equal to obj, and false otherwise.

getAttribute

public Object getAttribute(Object name)

Returns the value of the specified attribute, or null if there is no attribute with that name. If the attribute is not defined directly in this set, the parent hierarchy (if there is one) will be used.
Specified by:
getAttribute in interface AttributeSet
Parameters:
name - the attribute (null not permitted).
Throws:
NullPointerException - if name is null.

getAttributeCount

public int getAttributeCount()

Returns the number of attributes stored in this set, plus 1 if a parent has been specified (the reference to the parent is stored as a special attribute). The attributes stored in the parent do NOT contribute to the count.
Specified by:
getAttributeCount in interface AttributeSet
Returns:
The attribute count.

getAttributeNames

public Enumeration getAttributeNames()

Returns an enumeration of the attribute names.
Specified by:
getAttributeNames in interface AttributeSet
Returns:
An enumeration of the attribute names.

getResolveParent

public AttributeSet getResolveParent()

Returns the resolving parent.
Specified by:
getResolveParent in interface AttributeSet
Returns:
The resolving parent (possibly null).
See Also:
setResolveParent(AttributeSet)

hashCode

public int hashCode()

Returns a hash code for this instance.
Overrides:
hashCode in interface Object
Returns:
A hash code.

isDefined

public boolean isDefined(Object attrName)

Returns true if the given attribute is defined in this set, and false otherwise. The parent attribute set is not checked.
Specified by:
isDefined in interface AttributeSet
Parameters:
attrName - the attribute name (null not permitted).

isEmpty

public boolean isEmpty()

Returns true if the set contains no attributes, and false otherwise. Note that the resolving parent is stored as an attribute, so this method will return false if a resolving parent is set.
Returns:
true if the set contains no attributes, and false otherwise.

isEqual

public boolean isEqual(AttributeSet attr)

Returns true if the given set has the same number of attributes as this set and containsAttributes(attr) returns true.
Specified by:
isEqual in interface AttributeSet
Parameters:
attr - the attribute set (null not permitted).
Returns:
A boolean.
Throws:
NullPointerException - if attr is null.

removeAttribute

public void removeAttribute(Object name)

Removes the attribute with the specified name, if this attribute is defined. This method will only remove an attribute from this set, not from the resolving parent.
Specified by:
removeAttribute in interface MutableAttributeSet
Parameters:
name - the attribute name (null not permitted).
Throws:
NullPointerException - if name is null.

removeAttributes

public void removeAttributes(Enumeration names)

Removes the attributes listed in names.
Specified by:
removeAttributes in interface MutableAttributeSet
Parameters:
names - the attribute names (null not permitted).
Throws:
NullPointerException - if names is null or contains any null values.

removeAttributes

public void removeAttributes(AttributeSet attributes)

Removes attributes from this set if they are found in the given set. Only attributes whose key AND value are removed. Removes attributes only from this set, not from the resolving parent. Since the resolving parent is stored as an attribute, if attributes has the same resolving parent as this set, the parent will be removed from this set.
Specified by:
removeAttributes in interface MutableAttributeSet
Parameters:
attributes - the attributes (null not permitted).

setResolveParent

public void setResolveParent(AttributeSet parent)

Sets the reolving parent for this set. When looking up an attribute, if it is not found in this set, then the resolving parent is also used for the lookup.
Note that the parent is stored as an attribute, and will contribute 1 to the count returned by getAttributeCount().
Specified by:
setResolveParent in interface MutableAttributeSet
Parameters:
parent - the parent attribute set (null not permitted).
Throws:
NullPointerException - if parent is null.
See Also:
setResolveParent(AttributeSet)

toString

public String toString()

Returns a string representation of this instance, typically used for debugging purposes.
Overrides:
toString in interface Object
Returns:
A string representation of this instance.

SimpleAttributeSet.java -- Copyright (C) 2004, 2005, 2006 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.

Overview Package Class Use Source Tree Index Deprecated About

GNU Classpath (0.95)