AttributeListImpl

public class AttributeListImpl extends Object
implements AttributeList

This class is deprecated.
This class implements a deprecated interface, AttributeList; that interface has been replaced by Attributes, which is implemented in the AttributesImpl helper class.

Default implementation for AttributeList.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

AttributeList implements the deprecated SAX1 AttributeList interface, and has been replaced by the new SAX2 AttributesImpl interface.

This class provides a convenience implementation of the SAX AttributeList interface. This implementation is useful both for SAX parser writers, who can use it to provide attributes to the application, and for SAX application writers, who can use it to create a persistent copy of an element's attribute specifications:

 private AttributeList myatts;

 public void startElement (String name, AttributeList atts)
 {
              // create a persistent copy of the attribute list
              // for use outside this method
   myatts = new AttributeListImpl(atts);
   [...]
 }
 

Please note that SAX parsers are not required to use this class to provide an implementation of AttributeList; it is supplied only as an optional convenience. In particular, parser writers are encouraged to invent more efficient implementations.

See Also

• AttributeList
• DocumentHandler.startElement(String, AttributeList)

Public Constructor Summary

	AttributeListImpl() Create an empty attribute list.
	AttributeListImpl(AttributeList atts) Construct a persistent copy of an existing attribute list.

Public Method Summary

void	addAttribute(String name, String type, String value) Add an attribute to an attribute list.
void	clear() Clear the attribute list.
int	getLength() Return the number of attributes in the list.
String	getName(int i) Get the name of an attribute (by position).
String	getType(String name) Get the type of an attribute (by name).
String	getType(int i) Get the type of an attribute (by position).
String	getValue(String name) Get the value of an attribute (by name).
String	getValue(int i) Get the value of an attribute (by position).
void	removeAttribute(String name) Remove an attribute from the list.
void	setAttributeList(AttributeList atts) Set the attribute list, discarding previous contents.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.AttributeList

abstract int	getLength() Return the number of attributes in this list.
abstract String	getName(int i) Return the name of an attribute in this list (by position).
abstract String	getType(String name) Return the type of an attribute in the list (by name).
abstract String	getType(int i) Return the type of an attribute in the list (by position).
abstract String	getValue(String name) Return the value of an attribute in the list (by name).
abstract String	getValue(int i) Return the value of an attribute in the list (by position).

Public Constructors

public AttributeListImpl ()

Create an empty attribute list.

This constructor is most useful for parser writers, who will use it to create a single, reusable attribute list that can be reset with the clear method between elements.

See Also

• addAttribute(String, String, String)
• clear()

public AttributeListImpl (AttributeList atts)

Construct a persistent copy of an existing attribute list.

This constructor is most useful for application writers, who will use it to create a persistent copy of an existing attribute list.

Parameters

atts	The attribute list to copy

See Also

• DocumentHandler.startElement(String, AttributeList)

Public Methods

public void addAttribute (String name, String type, String value)

Add an attribute to an attribute list.

This method is provided for SAX parser writers, to allow them to build up an attribute list incrementally before delivering it to the application.

Parameters

name	The attribute name.
type	The attribute type ("NMTOKEN" for an enumeration).
value	The attribute value (must not be null).

See Also

• removeAttribute(String)
• DocumentHandler.startElement(String, AttributeList)

public void clear ()

Clear the attribute list.

SAX parser writers can use this method to reset the attribute list between DocumentHandler.startElement events. Normally, it will make sense to reuse the same AttributeListImpl object rather than allocating a new one each time.

See Also

• DocumentHandler.startElement(String, AttributeList)

public int getLength ()

Return the number of attributes in the list.

Returns

• The number of attributes in the list.

See Also

• AttributeList.getLength()

public String getName (int i)

Get the name of an attribute (by position).

Parameters

i	The position of the attribute in the list.

Returns

• The attribute name as a string, or null if there is no attribute at that position.

See Also

• AttributeList.getName(int)

public String getType (String name)

Get the type of an attribute (by name).

Parameters

name	The attribute name.

Returns

• The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read).

See Also

• AttributeList.getType(java.lang.String)

public String getType (int i)

Get the type of an attribute (by position).

Parameters

i	The position of the attribute in the list.

Returns

• The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read), or null if there is no attribute at that position.

See Also

• AttributeList.getType(int)

public String getValue (String name)

Get the value of an attribute (by name).

Parameters

name	The attribute name.

Returns

• the named attribute's value or null, if the attribute does not exist.

See Also

• AttributeList.getValue(java.lang.String)

public String getValue (int i)

Get the value of an attribute (by position).

Parameters

i	The position of the attribute in the list.

Returns

• The attribute value as a string, or null if there is no attribute at that position.

See Also

• AttributeList.getValue(int)

public void removeAttribute (String name)

Remove an attribute from the list.

SAX application writers can use this method to filter an attribute out of an AttributeList. Note that invoking this method will change the length of the attribute list and some of the attribute's indices.

If the requested attribute is not in the list, this is a no-op.

Parameters

name	The attribute name.

See Also

• addAttribute(String, String, String)

public void setAttributeList (AttributeList atts)

Set the attribute list, discarding previous contents.

This method allows an application writer to reuse an attribute list easily.

Parameters

atts	The attribute list to copy.