1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
// Attributes2.java - extended Attributes // http://www.saxproject.org // Public Domain: no warranty. // $Id: Attributes2.java,v 1.2 2004/11/03 22:49:07 jsuttor Exp $ package org.xml.sax.ext; import org.xml.sax.Attributes; /** * SAX2 extension to augment the per-attribute information * provided though {@link Attributes}. * If an implementation supports this extension, the attributes * provided in {@link org.xml.sax.ContentHandler#startElement * ContentHandler.startElement() } will implement this interface, * and the <em>http://xml.org/sax/features/use-attributes2</em> * feature flag will have the value <em>true</em>. * * <blockquote> * <em>This module, both source code and documentation, is in the * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> * </blockquote> * * <p> XMLReader implementations are not required to support this * information, and it is not part of core-only SAX2 distributions.</p> * * <p>Note that if an attribute was defaulted (<em>!isSpecified()</em>) * it will of necessity also have been declared (<em>isDeclared()</em>) * in the DTD. * Similarly if an attribute's type is anything except CDATA, then it * must have been declared. * </p> * * @since SAX 2.0 (extensions 1.1 alpha) * @author David Brownell * @version TBS */ public interface Attributes2 extends Attributes { /** * Returns false unless the attribute was declared in the DTD. * This helps distinguish two kinds of attributes that SAX reports * as CDATA: ones that were declared (and hence are usually valid), * and those that were not (and which are never valid). * * @param index The attribute index (zero-based). * @return true if the attribute was declared in the DTD, * false otherwise. * @exception java.lang.ArrayIndexOutOfBoundsException When the * supplied index does not identify an attribute. */ public boolean isDeclared (int index); /** * Returns false unless the attribute was declared in the DTD. * This helps distinguish two kinds of attributes that SAX reports * as CDATA: ones that were declared (and hence are usually valid), * and those that were not (and which are never valid). * * @param qName The XML qualified (prefixed) name. * @return true if the attribute was declared in the DTD, * false otherwise. * @exception java.lang.IllegalArgumentException When the * supplied name does not identify an attribute. */ public boolean isDeclared (String qName); /** * Returns false unless the attribute was declared in the DTD. * This helps distinguish two kinds of attributes that SAX reports * as CDATA: ones that were declared (and hence are usually valid), * and those that were not (and which are never valid). * * <p>Remember that since DTDs do not "understand" namespaces, the * namespace URI associated with an attribute may not have come from * the DTD. The declaration will have applied to the attribute's * <em>qName</em>. * * @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 attribute was declared in the DTD, * false otherwise. * @exception java.lang.IllegalArgumentException When the * supplied names do not identify an attribute. */ public boolean isDeclared (String uri, String localName); /** * 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. * @exception java.lang.ArrayIndexOutOfBoundsException When the * supplied index does not identify an attribute. */ public boolean isSpecified (int index); /** * Returns true unless the attribute value was provided * by DTD defaulting. * * <p>Remember that since DTDs do not "understand" namespaces, the * namespace URI associated with an attribute may not have come from * the DTD. The declaration will have applied to the attribute's * <em>qName</em>. * * @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. * @exception java.lang.IllegalArgumentException When the * supplied names do not identify an attribute. */ public boolean isSpecified (String uri, String localName); /** * Returns true unless the attribute value was provided * by DTD defaulting. * * @param qName The XML qualified (prefixed) name. * @return true if the value was found in the XML text, * false if the value was provided by DTD defaulting. * @exception java.lang.IllegalArgumentException When the * supplied name does not identify an attribute. */ public boolean isSpecified (String qName); }