⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.xml.sax.ext

Class Attributes2Impl

java.lang.Object
|
+--org.xml.sax.helpers.AttributesImpl
   |
   +--org.xml.sax.ext.Attributes2Impl

All Implemented Interfaces:
Attributes, Attributes2


public class Attributes2Impl
extends AttributesImpl
implements Attributes2

SAX2 extension helper for additional Attributes information, implementing the Attributes2 interface.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is not part of core-only SAX2 distributions.

The specified flag for each attribute will always be true, unless it has been set to false in the copy constructor or using setSpecified.

Since:
SAX 2.0 (extensions 1.1 alpha)
Author:
David Brownell

Constructor Summary

Attributes2Impl()

Construct a new, empty Attributes2Impl object.

Attributes2Impl(Attributes atts)

Copy an existing Attributes or Attributes2 object.

Method Summary

void

addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String qName, java.lang.String type, java.lang.String value)

Add an attribute to the end of the list, setting its "specified" flag to true.

boolean

isDeclared(int index)

boolean

isDeclared(java.lang.String qName)

boolean

isDeclared(java.lang.String uri, java.lang.String localName)

boolean

isSpecified(int index)

Returns the current value of an attribute's "specified" flag.

boolean

isSpecified(java.lang.String uri, java.lang.String localName)

Returns the current value of an attribute's "specified" flag.

boolean

isSpecified(java.lang.String qName)

Returns the current value of an attribute's "specified" flag.

void

removeAttribute(int index)

void

setAttributes(Attributes atts)

Copy an entire Attributes object.

void

setDeclared(int index, boolean value)

Assign a value to the "declared" flag of a specific attribute.

void

setSpecified(int index, boolean value)

Assign a value to the "specified" flag of a specific attribute.

Constructor Details

Attributes2Impl

public Attributes2Impl()

Construct a new, empty Attributes2Impl object.


Attributes2Impl

public Attributes2Impl(Attributes atts)

Copy an existing Attributes or Attributes2 object. If the object implements Attributes2, values of the specified flag for each attribute are copied, otherwise the flag values are set to true.

This constructor is especially useful inside a org.xml.sax.ContentHandler.startElement startElement event.

Parameters:
atts - The existing Attributes object.

Method Details

addAttribute

public void addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String qName, java.lang.String type, java.lang.String value)

Add an attribute to the end of the list, setting its "specified" flag to true. To set that flag's value to false, use setSpecified.

Parameters:
uri
localName
qName
type
value
See Also:
AttributesImpl.addAttribute

isDeclared

public boolean isDeclared(int index)

Parameters:
index
Returns:
false unless the attribute was declared in the DTD.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isDeclared

public boolean isDeclared(java.lang.String uri, java.lang.String localName)

Parameters:
uri
localName
Returns:
false unless the attribute was declared in the DTD.
Throws:
java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isDeclared

public boolean isDeclared(java.lang.String qName)

Parameters:
qName
Returns:
false unless the attribute was declared in the DTD.
Throws:
java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified

public boolean isSpecified(int index)

Returns the current value of an attribute's "specified" flag.

Parameters:
index - The attribute index (zero-based).
Returns:
current flag value
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isSpecified

public boolean isSpecified(java.lang.String uri, java.lang.String localName)

Returns the current value of an attribute's "specified" flag.

Parameters:
uri - The Namespace URI, or the empty string if the name has no Namespace URI.
localName - The attribute's local name.
Returns:
current flag value
Throws:
java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified

public boolean isSpecified(java.lang.String qName)

Returns the current value of an attribute's "specified" flag.

Parameters:
qName - The XML 1.0 qualified name.
Returns:
current flag value
Throws:
java.lang.IllegalArgumentException - When the supplied name does not identify an attribute.

removeAttribute

public void removeAttribute(int index)

Parameters:
index

setAttributes

public void setAttributes(Attributes atts)

Copy an entire Attributes object. The "specified" flags are assigned as true, unless the object is an Attributes2 object in which case those values are copied.

Parameters:
atts
See Also:
AttributesImpl.setAttributes

setDeclared

public void setDeclared(int index, boolean value)

Assign a value to the "declared" flag of a specific attribute. This is the only way this flag can be cleared, except clearing by initialization with the copy constructor.

Parameters:
index - The index of the attribute (zero-based).
value - The desired flag value.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

setSpecified

public void setSpecified(int index, boolean value)

Assign a value to the "specified" flag of a specific attribute. This is the only way this flag can be cleared, except clearing by initialization with the copy constructor.

Parameters:
index - The index of the attribute (zero-based).
value - The desired flag value.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.