+++ /dev/null
-// SAX Attribute List Interface.\r
-// No warranty; no copyright -- use this as you will.\r
-// $Id: AttributeList.java,v 1.1 2000/10/02 02:43:16 sboag Exp $\r
-\r
-package org.xml.sax;\r
-\r
-/**\r
- * Interface for an element's attribute specifications.\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 is the original SAX1 interface for reporting an element's\r
- * attributes. Unlike the new {@link org.xml.sax.Attributes Attributes}\r
- * interface, it does not support Namespace-related information.</p>\r
- *\r
- * <p>When an attribute list is supplied as part of a\r
- * {@link org.xml.sax.DocumentHandler#startElement startElement}\r
- * event, the list will return valid results only during the\r
- * scope of the event; once the event handler returns control\r
- * to the parser, the attribute list is invalid. To save a\r
- * persistent copy of the attribute list, use the SAX1\r
- * {@link org.xml.sax.helpers.AttributeListImpl AttributeListImpl}\r
- * helper class.</p>\r
- *\r
- * <p>An attribute list includes only attributes that have been\r
- * specified or defaulted: #IMPLIED attributes will not be included.</p>\r
- *\r
- * <p>There are two ways for the SAX application to obtain information\r
- * from the AttributeList. First, it can iterate through the entire\r
- * list:</p>\r
- *\r
- * <pre>\r
- * public void startElement (String name, AttributeList atts) {\r
- * for (int i = 0; i < atts.getLength(); i++) {\r
- * String name = atts.getName(i);\r
- * String type = atts.getType(i);\r
- * String value = atts.getValue(i);\r
- * [...]\r
- * }\r
- * }\r
- * </pre>\r
- *\r
- * <p>(Note that the result of getLength() will be zero if there\r
- * are no attributes.)\r
- *\r
- * <p>As an alternative, the application can request the value or\r
- * type of specific attributes:</p>\r
- *\r
- * <pre>\r
- * public void startElement (String name, AttributeList atts) {\r
- * String identifier = atts.getValue("id");\r
- * String label = atts.getValue("label");\r
- * [...]\r
- * }\r
- * </pre>\r
- *\r
- * @deprecated This interface has been replaced by the SAX2\r
- * {@link org.xml.sax.Attributes Attributes}\r
- * interface, which includes Namespace support.\r
- * @since SAX 1.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.DocumentHandler#startElement startElement\r
- * @see org.xml.sax.helpers.AttributeListImpl AttributeListImpl\r
- */\r
-public interface AttributeList {\r
-\r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Iteration methods.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
-\r
- /**\r
- * Return the number of attributes in this list.\r
- *\r
- * <p>The SAX parser may provide attributes in any\r
- * arbitrary order, regardless of the order in which they were\r
- * declared or specified. The number of attributes may be\r
- * zero.</p>\r
- *\r
- * @return The number of attributes in the list. \r
- */\r
- public abstract int getLength ();\r
- \r
- \r
- /**\r
- * Return the name of an attribute in this list (by position).\r
- *\r
- * <p>The names must be unique: the SAX parser shall not include the\r
- * same attribute twice. Attributes without values (those declared\r
- * #IMPLIED without a value specified in the start tag) will be\r
- * omitted from the list.</p>\r
- *\r
- * <p>If the attribute name has a namespace prefix, the prefix\r
- * will still be attached.</p>\r
- *\r
- * @param i The index of the attribute in the list (starting at 0).\r
- * @return The name of the indexed attribute, or null\r
- * if the index is out of range.\r
- * @see #getLength \r
- */\r
- public abstract String getName (int i);\r
- \r
- \r
- /**\r
- * Return the type of an attribute in the list (by position).\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 i The index of the attribute in the list (starting at 0).\r
- * @return The attribute type as a string, or\r
- * null if the index is out of range.\r
- * @see #getLength \r
- * @see #getType(java.lang.String)\r
- */\r
- public abstract String getType (int i);\r
- \r
- \r
- /**\r
- * Return the value of an attribute in the list (by position).\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 separated by whitespace.</p>\r
- *\r
- * @param i The index of the attribute in the list (starting at 0).\r
- * @return The attribute value as a string, or\r
- * null if the index is out of range.\r
- * @see #getLength\r
- * @see #getValue(java.lang.String)\r
- */\r
- public abstract String getValue (int i);\r
-\r
-\r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Lookup methods.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
- \r
- /**\r
- * Return the type of an attribute in the list (by name).\r
- *\r
- * <p>The return value is the same as the return value for\r
- * getType(int).</p>\r
- *\r
- * <p>If the attribute name has a namespace prefix in the document,\r
- * the application must include the prefix here.</p>\r
- *\r
- * @param name The name of the attribute.\r
- * @return The attribute type as a string, or null if no\r
- * such attribute exists.\r
- * @see #getType(int)\r
- */\r
- public abstract String getType (String name);\r
- \r
- \r
- /**\r
- * Return the value of an attribute in the list (by name).\r
- *\r
- * <p>The return value is the same as the return value for\r
- * getValue(int).</p>\r
- *\r
- * <p>If the attribute name has a namespace prefix in the document,\r
- * the application must include the prefix here.</p>\r
- *\r
- * @param i The index of the attribute in the list.\r
- * @return The attribute value as a string, or null if\r
- * no such attribute exists.\r
- * @see #getValue(int)\r
- */\r
- public abstract String getValue (String name);\r
- \r
-}\r
-\r
-// end of AttributeList.java\r
projects / msp430-gcc.git / blobdiff