OpenJDK 27 · org.xml.sax.helpers.AttributeListImpl · APIdia, the JavaDoc alternative

Default implementation for 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.

Modifier and Type	Field and Description
pack-priv List<String>	names
pack-priv List<String>	types
pack-priv List<String>	values

Constructor Summary

Access	Constructor and Description
public	AttributeListImpl() Create an empty attribute list.
public	AttributeListImpl(AttributeList The attribute list to copy atts) References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. Construct a persistent copy of an existing attribute list.

Method Summary

Modifier and Type	Method and Description
public void	addAttribute(String The attribute name. name, String The attribute type ("NMTOKEN" for an enumeration). type, String The attribute value (must not be null). value) Add an attribute to an attribute list.
public void	clear() Clear the attribute list.
public int	Returns: The number of attributes in the list. getLength() Implements org.xml.sax.AttributeList.getLength. Return the number of attributes in the list.
public String	Returns: The attribute name as a string, or null if there is no attribute at that position. getName(int The position of the attribute in the list. i) Implements org.xml.sax.AttributeList.getName. Get the name of an attribute (by position).
public String	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. getType(int The position of the attribute in the list. i) Implements org.xml.sax.AttributeList.getType. Get the type of an attribute (by position).
public String	Returns: The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read). getType(String The attribute name. name) Implements org.xml.sax.AttributeList.getType. Get the type of an attribute (by name).
public String	Returns: The attribute value as a string, or null if there is no attribute at that position. getValue(int The position of the attribute in the list. i) Implements org.xml.sax.AttributeList.getValue. Get the value of an attribute (by position).
public String	getValue(String The attribute name. name) Implements org.xml.sax.AttributeList.getValue. Get the value of an attribute (by name).
public void	removeAttribute(String The attribute name. name) Remove an attribute from the list.
public void	setAttributeList(AttributeList The attribute list to copy. atts) References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. Set the attribute list, discarding previous contents.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

names	back to summary
pack-priv List<String> names

types	back to summary
pack-priv List<String> types

values	back to summary
pack-priv List<String> values

Constructor Detail

AttributeListImpl back to summary

AttributeListImpl	back to summary
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`, `clear`

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, clear

AttributeListImpl back to summary

AttributeListImpl	back to summary
public AttributeListImpl(AttributeList atts) References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. 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:AttributeList The attribute list to copy See Also `org.xml.sax.DocumentHandler#startElement`

public AttributeListImpl(AttributeList atts)

References Deprecated

AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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:AttributeList: The attribute list to copy

Method Detail

addAttribute back to summary

addAttribute	back to summary
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:String The attribute name. type:String The attribute type ("NMTOKEN" for an enumeration). value:String The attribute value (must not be null). See Also `removeAttribute`, `org.xml.sax.DocumentHandler#startElement`

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:String: The attribute name.
type:String: The attribute type ("NMTOKEN" for an enumeration).
value:String: The attribute value (must not be null).

clear back to summary

clear	back to summary
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 `org.xml.sax.DocumentHandler#startElement`

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: org.xml.sax.DocumentHandler#startElement

getLength back to summary

getLength	back to summary
public int getLength() Implements org.xml.sax.AttributeList.getLength. Return the number of attributes in the list. Returns:int The number of attributes in the list. See Also `org.xml.sax.AttributeList#getLength`

public int getLength()

Implements org.xml.sax.AttributeList.getLength.

Return the number of attributes in the list.

Returns:int: The number of attributes in the list.
See Also: org.xml.sax.AttributeList#getLength

getName back to summary

getName	back to summary
public String getName(int i) Implements org.xml.sax.AttributeList.getName. Get the name of an attribute (by position). Parameters i:int The position of the attribute in the list. Returns:String The attribute name as a string, or null if there is no attribute at that position. See Also `org.xml.sax.AttributeList#getName(int)`

public String getName(int i)

Implements org.xml.sax.AttributeList.getName.

Get the name of an attribute (by position).

Parameters

i:int: The position of the attribute in the list.

Returns:String

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

getType back to summary

getType	back to summary
public String getType(int i) Implements org.xml.sax.AttributeList.getType. Get the type of an attribute (by position). Parameters i:int The position of the attribute in the list. Returns:String 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 `org.xml.sax.AttributeList#getType(int)`

public String getType(int i)

Implements org.xml.sax.AttributeList.getType.

Get the type of an attribute (by position).

Parameters

i:int: The position of the attribute in the list.

Returns:String

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.

getType back to summary

getType	back to summary
public String getType(String name) Implements org.xml.sax.AttributeList.getType. Get the type of an attribute (by name). Parameters name:String The attribute name. Returns:String The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read). See Also `org.xml.sax.AttributeList#getType(java.lang.String)`

public String getType(String name)

Implements org.xml.sax.AttributeList.getType.

Get the type of an attribute (by name).

Parameters

name:String: The attribute name.

Returns:String

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

getValue back to summary

getValue	back to summary
public String getValue(int i) Implements org.xml.sax.AttributeList.getValue. Get the value of an attribute (by position). Parameters i:int The position of the attribute in the list. Returns:String The attribute value as a string, or null if there is no attribute at that position. See Also `org.xml.sax.AttributeList#getValue(int)`

public String getValue(int i)

Implements org.xml.sax.AttributeList.getValue.

Get the value of an attribute (by position).

Parameters

i:int: The position of the attribute in the list.

Returns:String

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

getValue back to summary

getValue	back to summary
public String getValue(String name) Implements org.xml.sax.AttributeList.getValue. Get the value of an attribute (by name). Parameters name:String The attribute name. See Also `org.xml.sax.AttributeList#getValue(java.lang.String)`

public String getValue(String name)

Implements org.xml.sax.AttributeList.getValue.

Get the value of an attribute (by name).

Parameters

name:String: The attribute name.

removeAttribute back to summary

removeAttribute	back to summary
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:String The attribute name. See Also `addAttribute`

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:String: The attribute name.

See Also

addAttribute

setAttributeList back to summary

setAttributeList	back to summary
public void setAttributeList(AttributeList atts) References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Set the attribute list, discarding previous contents. This method allows an application writer to reuse an attribute list easily. Parameters atts:AttributeList The attribute list to copy.

public void setAttributeList(AttributeList atts)

References Deprecated

AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Set the attribute list, discarding previous contents.

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

Parameters

atts:AttributeList: The attribute list to copy.

public Class AttributeListImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail