This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


org.xml.sax.ext
class Attributes2Impl

java.lang.Object extended by org.xml.sax.helpers.AttributesImpl extended by 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 {@link 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 {@link #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 {@link #setDeclared}. If you change an attribute's type by hand, you may need to modify its declared flag to match.


Constructor Summary

          Construct a new, empty Attributes2Impl object.

          Copy an existing Attributes or Attributes2 object.
 
Method Summary
 void
addAttribute(String uri, String localName, String qName, String type, String value)

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

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

          Returns the current value of the attribute's "declared" flag.
 boolean
isDeclared(String uri, String localName)

          Returns the current value of the attribute's "declared" flag.
 boolean
isSpecified(int index)

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

          Returns the current value of an attribute's "specified" flag.
 boolean
isSpecified(String uri, String localName)

          Returns the current value of an attribute's "specified" flag.
 void
removeAttribute(int index)

          Remove an attribute from the list.
 void

          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.
 
Methods inherited from class org.xml.sax.helpers.AttributesImpl
addAttribute, clear, getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue, removeAttribute, setAttribute, setAttributes, setLocalName, setQName, setType, setURI, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 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 {@link org.xml.sax.ContentHandler#startElement startElement} event.

Parameters:
atts - The existing Attributes object.
Method Detail

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String qName,
                         String type,
                         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 {@link #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 {@link #setDeclared}.

Overrides:
addAttribute in class AttributesImpl
Parameters:
uri
localName
qName
type
value

isDeclared

public boolean isDeclared(int index)
Returns the current value of the attribute's "declared" flag.

Parameters:
index

isDeclared

public boolean isDeclared(String qName)
Returns the current value of the attribute's "declared" flag.

Parameters:
qName

isDeclared

public boolean isDeclared(String uri,
                          String localName)
Returns the current value of the attribute's "declared" flag.

Parameters:
uri
localName

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

isSpecified

public boolean isSpecified(String qName)
Returns the current value of an attribute's "specified" flag.

Parameters:
qName - The XML qualified (prefixed) name.
Returns:
current flag value

isSpecified

public boolean isSpecified(String uri,
                           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

removeAttribute

public void removeAttribute(int index)
Overrides:
removeAttribute in class AttributesImpl
Parameters:
index

setAttributes

public void setAttributes(Attributes atts)
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.

Overrides:
setAttributes in class AttributesImpl
Parameters:
atts

setDeclared

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 - The index of the attribute (zero-based).
value - The desired flag value.

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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.