+++ /dev/null
-// Attributes.java - attribute list with Namespace support\r
-// Written by David Megginson, sax@megginson.com\r
-// NO WARRANTY! This class is in the public domain.\r
-\r
-// $Id: Attributes.java,v 1.1 2000/10/02 02:43:16 sboag Exp $\r
-\r
-\r
-package org.xml.sax;\r
-\r
-\r
-/**\r
- * Interface for a list of XML attributes.\r
- *\r
- * <blockquote>\r
- * <em>This module, both source code and documentation, is in the\r
- * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>\r
- * </blockquote>\r
- *\r
- * <p>This interface allows access to a list of attributes in\r
- * three different ways:</p>\r
- *\r
- * <ol>\r
- * <li>by attribute index;</li>\r
- * <li>by Namespace-qualified name; or</li>\r
- * <li>by qualified (prefixed) name.</li>\r
- * </ol>\r
- *\r
- * <p>The list will not contain attributes that were declared\r
- * #IMPLIED but not specified in the start tag. It will also not\r
- * contain attributes used as Namespace declarations (xmlns*) unless\r
- * the <code>http://xml.org/sax/features/namespace-prefixes</code> \r
- * feature is set to <var>true</var> (it is <var>false</var> by \r
- * default).</p>\r
- *\r
- * <p>If the namespace-prefixes feature (see above) is <var>false</var>, \r
- * access by qualified name may not be available; if the \r
- * <code>http://xml.org/sax/features/namespaces</code>\r
- * feature is <var>false</var>, access by Namespace-qualified names \r
- * may not be available.</p>\r
- *\r
- * <p>This interface replaces the now-deprecated SAX1 {@link\r
- * org.xml.sax.AttributeList AttributeList} interface, which does not \r
- * contain Namespace support. In addition to Namespace support, it \r
- * adds the <var>getIndex</var> methods (below).</p>\r
- *\r
- * <p>The order of attributes in the list is unspecified, and will\r
- * vary from implementation to implementation.</p>\r
- *\r
- * @since SAX 2.0\r
- * @author David Megginson, \r
- * <a href="mailto:sax@megginson.com">sax@megginson.com</a>\r
- * @version 2.0\r
- * @see org.xml.sax.helpers.AttributeListImpl\r
- */\r
-public interface Attributes\r
-{\r
-\r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Indexed access.\r
- ////////////////////////////////////////////////////////////////////\r
-\r
-\r
- /**\r
- * Return the number of attributes in the list.\r
- *\r
- * <p>Once you know the number of attributes, you can iterate\r
- * through the list.</p>\r
- *\r
- * @return The number of attributes in the list.\r
- * @see #getURI(int)\r
- * @see #getLocalName(int)\r
- * @see #getQName(int)\r
- * @see #getType(int)\r
- * @see #getValue(int)\r
- */\r
- public abstract int getLength ();\r
-\r
-\r
- /**\r
- * Look up an attribute's Namespace URI by index.\r
- *\r
- * @param index The attribute index (zero-based).\r
- * @return The Namespace URI, or the empty string if none\r
- * is available, or null if the index is out of\r
- * range.\r
- * @see #getLength\r
- */\r
- public abstract String getURI (int index);\r
-\r
-\r
- /**\r
- * Look up an attribute's local name by index.\r
- *\r
- * @param index The attribute index (zero-based).\r
- * @return The local name, or the empty string if Namespace\r
- * processing is not being performed, or null\r
- * if the index is out of range.\r
- * @see #getLength\r
- */\r
- public abstract String getLocalName (int index);\r
-\r
-\r
- /**\r
- * Look up an attribute's XML 1.0 qualified name by index.\r
- *\r
- * @param index The attribute index (zero-based).\r
- * @return The XML 1.0 qualified name, or the empty string\r
- * if none is available, or null if the index\r
- * is out of range.\r
- * @see #getLength\r
- */\r
- public abstract String getQName (int index);\r
-\r
-\r
- /**\r
- * Look up an attribute's type by index.\r
- *\r
- * <p>The attribute type is one of the strings "CDATA", "ID",\r
- * "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES",\r
- * or "NOTATION" (always in upper case).</p>\r
- *\r
- * <p>If the parser has not read a declaration for the attribute,\r
- * or if the parser does not report attribute types, then it must\r
- * return the value "CDATA" as stated in the XML 1.0 Recommentation\r
- * (clause 3.3.3, "Attribute-Value Normalization").</p>\r
- *\r
- * <p>For an enumerated attribute that is not a notation, the\r
- * parser will report the type as "NMTOKEN".</p>\r
- *\r
- * @param index The attribute index (zero-based).\r
- * @return The attribute's type as a string, or null if the\r
- * index is out of range.\r
- * @see #getLength\r
- */\r
- public abstract String getType (int index);\r
-\r
-\r
- /**\r
- * Look up an attribute's value by index.\r
- *\r
- * <p>If the attribute value is a list of tokens (IDREFS,\r
- * ENTITIES, or NMTOKENS), the tokens will be concatenated\r
- * into a single string with each token separated by a\r
- * single space.</p>\r
- *\r
- * @param index The attribute index (zero-based).\r
- * @return The attribute's value as a string, or null if the\r
- * index is out of range.\r
- * @see #getLength\r
- */\r
- public abstract String getValue (int index);\r
-\r
-\r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Name-based query.\r
- ////////////////////////////////////////////////////////////////////\r
-\r
-\r
- /**\r
- * Look up the index of an attribute by Namespace name.\r
- *\r
- * @param uri The Namespace URI, or the empty string if\r
- * the name has no Namespace URI.\r
- * @param localName The attribute's local name.\r
- * @return The index of the attribute, or -1 if it does not\r
- * appear in the list.\r
- */\r
- public int getIndex (String uri, String localPart);\r
-\r
-\r
- /**\r
- * Look up the index of an attribute by XML 1.0 qualified name.\r
- *\r
- * @param qName The qualified (prefixed) name.\r
- * @return The index of the attribute, or -1 if it does not\r
- * appear in the list.\r
- */\r
- public int getIndex (String qName);\r
-\r
-\r
- /**\r
- * Look up an attribute's type by Namespace name.\r
- *\r
- * <p>See {@link #getType(int) getType(int)} for a description\r
- * of the possible types.</p>\r
- *\r
- * @param uri The Namespace URI, or the empty String if the\r
- * name has no Namespace URI.\r
- * @param localName The local name of the attribute.\r
- * @return The attribute type as a string, or null if the\r
- * attribute is not in the list or if Namespace\r
- * processing is not being performed.\r
- */\r
- public abstract String getType (String uri, String localName);\r
-\r
-\r
- /**\r
- * Look up an attribute's type by XML 1.0 qualified name.\r
- *\r
- * <p>See {@link #getType(int) getType(int)} for a description\r
- * of the possible types.</p>\r
- *\r
- * @param qName The XML 1.0 qualified name.\r
- * @return The attribute type as a string, or null if the\r
- * attribute is not in the list or if qualified names\r
- * are not available.\r
- */\r
- public abstract String getType (String qName);\r
-\r
-\r
- /**\r
- * Look up an attribute's value by Namespace name.\r
- *\r
- * <p>See {@link #getValue(int) getValue(int)} for a description\r
- * of the possible values.</p>\r
- *\r
- * @param uri The Namespace URI, or the empty String if the\r
- * name has no Namespace URI.\r
- * @param localName The local name of the attribute.\r
- * @return The attribute value as a string, or null if the\r
- * attribute is not in the list.\r
- */\r
- public abstract String getValue (String uri, String localName);\r
-\r
-\r
- /**\r
- * Look up an attribute's value by XML 1.0 qualified name.\r
- *\r
- * <p>See {@link #getValue(int) getValue(int)} for a description\r
- * of the possible values.</p>\r
- *\r
- * @param qName The XML 1.0 qualified name.\r
- * @return The attribute value as a string, or null if the\r
- * attribute is not in the list or if qualified names\r
- * are not available.\r
- */\r
- public abstract String getValue (String qName);\r
-\r
-}\r
-\r
-// end of Attributes.java\r
projects / msp430-gcc.git / blobdiff