- All Implemented Interfaces:
AttributeList
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.
- Since:
- 1.4, SAX 1.0
- See Also:
-
Constructor Summary
ConstructorDescriptionDeprecated.Create an empty attribute list.Deprecated.Construct a persistent copy of an existing attribute list. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String name, String type, String value) Deprecated.Add an attribute to an attribute list.void
clear()
Deprecated.Clear the attribute list.int
Deprecated.Return the number of attributes in the list.getName
(int i) Deprecated.Get the name of an attribute (by position).getType
(int i) Deprecated.Get the type of an attribute (by position).Deprecated.Get the type of an attribute (by name).getValue
(int i) Deprecated.Get the value of an attribute (by position).Deprecated.Get the value of an attribute (by name).void
removeAttribute
(String name) Deprecated.Remove an attribute from the list.void
Deprecated.Set the attribute list, discarding previous contents.
-
Constructor Details
-
AttributeListImpl
public AttributeListImpl()Deprecated.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.
-
AttributeListImpl
Deprecated.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:
-
-
Method Details
-
setAttributeList
Deprecated.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.
-
addAttribute
Deprecated.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
Deprecated.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:
-
clear
public void clear()Deprecated.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.
-
getLength
public int getLength()Deprecated.Return the number of attributes in the list.- Specified by:
getLength
in interfaceAttributeList
- Returns:
- The number of attributes in the list.
- See Also:
-
getName
Deprecated.Get the name of an attribute (by position).- Specified by:
getName
in interfaceAttributeList
- 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:
-
getType
Deprecated.Get the type of an attribute (by position).- Specified by:
getType
in interfaceAttributeList
- 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:
-
getValue
Deprecated.Get the value of an attribute (by position).- Specified by:
getValue
in interfaceAttributeList
- 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:
-
getType
Deprecated.Get the type of an attribute (by name).- Specified by:
getType
in interfaceAttributeList
- 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:
-
getValue
Deprecated.Get the value of an attribute (by name).- Specified by:
getValue
in interfaceAttributeList
- Parameters:
name
- The attribute name.- Returns:
- The attribute value as a string, or null if no such attribute exists.
- See Also:
-
AttributeList
; that interface has been replaced byAttributes
, which is implemented in theAttributesImpl
helper class.