Top Description Fields Constructors Methods
org.xml.sax.ext

public Class Attributes2Impl

extends AttributesImpl
implements Attributes2
Class Inheritance
All Implemented Interfaces
org.xml.sax.ext.Attributes2, org.xml.sax.Attributes
Imports
org.xml.sax.Attributes, org.xml.sax.helpers.AttributesImpl

SAX2 extension helper for additional Attributes information, implementing the Attributes2 interface.

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. Similarly, the declared flag for each attribute will always be false, except for defaulted attributes (specified is false), non-CDATA attributes, or when it is set to true using setDeclared. If you change an attribute's type by hand, you may need to modify its declared flag to match.

Author
David Brownell
Since
1.5, SAX 2.0 (extensions 1.1 alpha)

Field Summary

Modifier and TypeField and Description
private boolean[]
private boolean[]

Constructor Summary

AccessConstructor and Description
public
Attributes2Impl()

Construct a new, empty Attributes2Impl object.

public
Attributes2Impl(Attributes
The existing Attributes object.
atts
)

Copy an existing Attributes or Attributes2 object.

Method Summary

Modifier and TypeMethod and Description
public void
addAttribute(String
The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
uri
,
String
The local name, or the empty string if Namespace processing is not being performed.
localName
,
String
The qualified (prefixed) name, or the empty string if qualified names are not available.
qName
,
String
The attribute type as a string.
type
,
String
The attribute value.
value
)

Overrides org.xml.sax.helpers.AttributesImpl.addAttribute.

Add an attribute to the end of the list, setting its "specified" flag to true.
public boolean
isDeclared(int
The attribute index (zero-based).
index
)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.
public boolean
isDeclared(String
The Namespace URI, or the empty string if the name has no Namespace URI.
uri
,
String
The attribute's local name.
localName
)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.
public boolean
isDeclared(String
The XML qualified (prefixed) name.
qName
)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.
public boolean

Returns:

current flag value
isSpecified
(int
The attribute index (zero-based).
index
)

Implements org.xml.sax.ext.Attributes2.isSpecified.

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

Returns:

current flag value
isSpecified
(String
The Namespace URI, or the empty string if the name has no Namespace URI.
uri
,
String
The attribute's local name.
localName
)

Implements org.xml.sax.ext.Attributes2.isSpecified.

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

Returns:

current flag value
isSpecified
(String
The XML qualified (prefixed) name.
qName
)

Implements org.xml.sax.ext.Attributes2.isSpecified.

Returns the current value of an attribute's "specified" flag.
public void
removeAttribute(int
The index of the attribute (zero-based).
index
)

Overrides org.xml.sax.helpers.AttributesImpl.removeAttribute.

Remove an attribute from the list.
public void
setAttributes(Attributes
The attributes to copy.
atts
)

Overrides org.xml.sax.helpers.AttributesImpl.setAttributes.

Copy an entire Attributes object.
public void
setDeclared(int
The index of the attribute (zero-based).
index
,
boolean
The desired flag value.
value
)

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

public void
setSpecified(int
The index of the attribute (zero-based).
index
,
boolean
The desired flag value.
value
)

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

Inherited from org.xml.sax.helpers.AttributesImpl:
cleargetIndexgetIndexgetLengthgetLocalNamegetQNamegetTypegetTypegetTypegetURIgetValuegetValuegetValuesetAttributesetLocalNamesetQNamesetTypesetURIsetValue

Field Detail

declaredback to summary
private boolean[] declared
specifiedback to summary
private boolean[] specified

Constructor Detail

Attributes2Implback to summary
public Attributes2Impl()

Construct a new, empty Attributes2Impl object.

Attributes2Implback to summary
public Attributes2Impl(Attributes atts)

Copy an existing Attributes or Attributes2 object. If the object implements Attributes2, values of the specified and declared flags for each attribute are copied. Otherwise the flag values are defaulted to assume no DTD was used, unless there is evidence to the contrary (such as attributes with type other than CDATA, which must have been declared).

This constructor is especially useful inside a startElement event.

Parameters
atts:Attributes

The existing Attributes object.

Method Detail

addAttributeback to summary
public void addAttribute(String uri, String localName, String qName, String type, String value)

Overrides org.xml.sax.helpers.AttributesImpl.addAttribute.

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.

Unless the attribute type is CDATA, this attribute is marked as being declared in the DTD. To set that flag's value to true for CDATA attributes, use setDeclared.

Parameters
uri:String

Doc from org.xml.sax.helpers.AttributesImpl.addAttribute.

The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.

localName:String

Doc from org.xml.sax.helpers.AttributesImpl.addAttribute.

The local name, or the empty string if Namespace processing is not being performed.

qName:String

Doc from org.xml.sax.helpers.AttributesImpl.addAttribute.

The qualified (prefixed) name, or the empty string if qualified names are not available.

type:String

Doc from org.xml.sax.helpers.AttributesImpl.addAttribute.

The attribute type as a string.

value:String

Doc from org.xml.sax.helpers.AttributesImpl.addAttribute.

The attribute value.

See Also
AttributesImpl#addAttribute
isDeclaredback to summary
public boolean isDeclared(int index)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.

Parameters
index:int

Doc from org.xml.sax.ext.Attributes2.isDeclared.

The attribute index (zero-based).

Returns:boolean

Doc from org.xml.sax.ext.Attributes2.isDeclared.

true if the attribute was declared in the DTD, false otherwise.

isDeclaredback to summary
public boolean isDeclared(String uri, String localName)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.

Parameters
uri:String

Doc from org.xml.sax.ext.Attributes2.isDeclared.

The Namespace URI, or the empty string if the name has no Namespace URI.

localName:String

Doc from org.xml.sax.ext.Attributes2.isDeclared.

The attribute's local name.

Returns:boolean

Doc from org.xml.sax.ext.Attributes2.isDeclared.

true if the attribute was declared in the DTD, false otherwise.

isDeclaredback to summary
public boolean isDeclared(String qName)

Implements org.xml.sax.ext.Attributes2.isDeclared.

Returns the current value of the attribute's "declared" flag.

Parameters
qName:String

Doc from org.xml.sax.ext.Attributes2.isDeclared.

The XML qualified (prefixed) name.

Returns:boolean

Doc from org.xml.sax.ext.Attributes2.isDeclared.

true if the attribute was declared in the DTD, false otherwise.

isSpecifiedback to summary
public boolean isSpecified(int index)

Implements org.xml.sax.ext.Attributes2.isSpecified.

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

Parameters
index:int

The attribute index (zero-based).

Returns:boolean

current flag value

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not identify an attribute.
isSpecifiedback to summary
public boolean isSpecified(String uri, String localName)

Implements org.xml.sax.ext.Attributes2.isSpecified.

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

Parameters
uri:String

The Namespace URI, or the empty string if the name has no Namespace URI.

localName:String

The attribute's local name.

Returns:boolean

current flag value

Exceptions
IllegalArgumentException:
When the supplied names do not identify an attribute.
isSpecifiedback to summary
public boolean isSpecified(String qName)

Implements org.xml.sax.ext.Attributes2.isSpecified.

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

Parameters
qName:String

The XML qualified (prefixed) name.

Returns:boolean

current flag value

Exceptions
IllegalArgumentException:
When the supplied name does not identify an attribute.
removeAttributeback to summary
public void removeAttribute(int index)

Overrides org.xml.sax.helpers.AttributesImpl.removeAttribute.

Doc from org.xml.sax.helpers.AttributesImpl.removeAttribute.

Remove an attribute from the list.

Parameters
index:int

The index of the attribute (zero-based).

setAttributesback to summary
public void setAttributes(Attributes atts)

Overrides org.xml.sax.helpers.AttributesImpl.setAttributes.

Copy an entire Attributes object. The "specified" flags are assigned as true, and "declared" flags as false (except when an attribute's type is not CDATA), unless the object is an Attributes2 object. In that case those flag values are all copied.

Parameters
atts:Attributes

Doc from org.xml.sax.helpers.AttributesImpl.setAttributes.

The attributes to copy.

See Also
AttributesImpl#setAttributes
setDeclaredback to summary
public void setDeclared(int index, boolean value)

Assign a value to the "declared" flag of a specific attribute. This is normally needed only for attributes of type CDATA, including attributes whose type is changed to or from CDATA.

Parameters
index:int

The index of the attribute (zero-based).

value:boolean

The desired flag value.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not identify an attribute.
See Also
setType
setSpecifiedback to summary
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:int

The index of the attribute (zero-based).

value:boolean

The desired flag value.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not identify an attribute.