arabica/include/SAX/ext/Attributes2.hpp

#ifndef ARABICA_ATTRIBUTES2_H
#define ARABICA_ATTRIBUTES2_H

// Attributes2.h
// $Id$

#include <SAX/ArabicaConfig.hpp>
#include <SAX/Attributes.hpp>

namespace Arabica
{
namespace SAX
{

/**
 * SAX2 extension to augment the per-attribute information provided though Attributes. 
 *
 * If an implementation supports 
 * this extension, the attributes provided in 
 * ContentHandler.startElement()  will implement this 
 * interface, and the http://xml.org/sax/features/use-attributes2  
 * feature flag will have the value true.
 *
 * @since SAX 2.0
 * @author Jez Higgins, 
 *         <a href="mailto:jez@jezuk.co.uk">jez@jezuk.co.uk</a>
 * @version 2.0
 * @see Attributes
 * @see Attributes2Impl
 */
template<class string_type, class string_adaptor>
class Attributes2 : public Attributes<string_type, string_adaptor>
{

public:
  typedef string_type stringT;
  virtual ~Attributes2() { }

  /**
   *  Returns true unless the attribute value was provided by DTD defaulting.
   *
   * @param index The attribute index (zero-based).
   * @return true if the value was found in the XML text, 
   *         false if the value was provided by DTD defaulting.
   * @throws std::out_of_range exception when the supplied index
   *         does not identify an attribute
   */
  virtual bool isSpecified(unsigned int index) const = 0;

  /**
   *  Returns true unless the attribute value was provided by DTD defaulting.
   *
   * @param qName The XML 1.0 qualified name.
   * @return true if the value was found in the XML text, 
   *         false if the value was provided by DTD defaulting.
   * @throws std::invalid_argument exception when the supplied name
   *         does not identify an attribute
   */
  virtual bool isSpecified(const stringT& qName) const = 0;

  /**
   *  Returns true unless the attribute value was provided by DTD defaulting.
   *
   * @param uri The Namespace URI, or the empty string if the name has no
   *         Namespace URI.
   * @param localName The attribute's local name.
   * @return true if the value was found in the XML text, 
   *         false if the value was provided by DTD defaulting.
   * @throws std::invalid_argument exception when the supplied names
   *         does not identify an attribute
   */
  virtual bool isSpecified(const stringT& uri, const stringT& localName) const = 0;
}; // class Attributes2

} // namespace SAX
} // namespace Arabica

#endif
// end of file