1 // SAX Attribute List Interface. 2 // http://www.saxproject.org 3 // No warranty; no copyright -- use this as you will. 4 // $Id: AttributeList.java,v 1.7 2004/04/26 17:34:34 dmegginson Exp $ 5 6 package org.xml.sax; 7 8 /** 9 * Interface for an element's attribute specifications. 10 * 11 * <blockquote> 12 * <em>This module, both source code and documentation, is in the 13 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> 14 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a> 15 * for further information. 16 * </blockquote> 17 * 18 * <p>This is the original SAX1 interface for reporting an element's 19 * attributes. Unlike the new {@link org.xml.sax.Attributes Attributes} 20 * interface, it does not support Namespace-related information.</p> 21 * 22 * <p>When an attribute list is supplied as part of a 23 * {@link org.xml.sax.DocumentHandler#startElement startElement} 24 * event, the list will return valid results only during the 25 * scope of the event; once the event handler returns control 26 * to the parser, the attribute list is invalid. To save a 27 * persistent copy of the attribute list, use the SAX1 28 * {@link org.xml.sax.helpers.AttributeListImpl AttributeListImpl} 29 * helper class.</p> 30 * 31 * <p>An attribute list includes only attributes that have been 32 * specified or defaulted: #IMPLIED attributes will not be included.</p> 33 * 34 * <p>There are two ways for the SAX application to obtain information 35 * from the AttributeList. First, it can iterate through the entire 36 * list:</p> 37 * 38 * <pre> 39 * public void startElement (String name, AttributeList atts) { 40 * for (int i = 0; i < atts.getLength(); i++) { 41 * String name = atts.getName(i); 42 * String type = atts.getType(i); 43 * String value = atts.getValue(i); 44 * [...] 45 * } 46 * } 47 * </pre> 48 * 49 * <p>(Note that the result of getLength() will be zero if there 50 * are no attributes.) 51 * 52 * <p>As an alternative, the application can request the value or 53 * type of specific attributes:</p> 54 * 55 * <pre> 56 * public void startElement (String name, AttributeList atts) { 57 * String identifier = atts.getValue("id"); 58 * String label = atts.getValue("label"); 59 * [...] 60 * } 61 * </pre> 62 * 63 * @deprecated This interface has been replaced by the SAX2 64 * {@link org.xml.sax.Attributes Attributes} 65 * interface, which includes Namespace support. 66 * @since SAX 1.0 67 * @author David Megginson 68 * @version 2.0.1 (sax2r2) 69 * @see org.xml.sax.DocumentHandler#startElement startElement 70 * @see org.xml.sax.helpers.AttributeListImpl AttributeListImpl 71 */ 72 @Deprecated 73 public interface AttributeList { 74 75 76 //////////////////////////////////////////////////////////////////// 78 // Iteration methods. 79 //////////////////////////////////////////////////////////////////// 80 81 82 /** 83 * Return the number of attributes in this list. 84 * 85 * <p>The SAX parser may provide attributes in any 86 * arbitrary order, regardless of the order in which they were 87 * declared or specified. The number of attributes may be 88 * zero.</p> 89 * 90 * @return The number of attributes in the list. 91 */ 92 public abstract int getLength (); 93 94 95 /** 96 * Return the name of an attribute in this list (by position). 97 * 98 * <p>The names must be unique: the SAX parser shall not include the 99 * same attribute twice. Attributes without values (those declared 100 * #IMPLIED without a value specified in the start tag) will be 101 * omitted from the list.</p> 102 * 103 * <p>If the attribute name has a namespace prefix, the prefix 104 * will still be attached.</p> 105 * 106 * @param i The index of the attribute in the list (starting at 0). 107 * @return The name of the indexed attribute, or null 108 * if the index is out of range. 109 * @see #getLength 110 */ 111 public abstract String getName (int i); 112 113 114 /** 115 * Return the type of an attribute in the list (by position). 116 * 117 * <p>The attribute type is one of the strings "CDATA", "ID", 118 * "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", 119 * or "NOTATION" (always in upper case).</p> 120 * 121 * <p>If the parser has not read a declaration for the attribute, 122 * or if the parser does not report attribute types, then it must 123 * return the value "CDATA" as stated in the XML 1.0 Recommentation 124 * (clause 3.3.3, "Attribute-Value Normalization").</p> 125 * 126 * <p>For an enumerated attribute that is not a notation, the 127 * parser will report the type as "NMTOKEN".</p> 128 * 129 * @param i The index of the attribute in the list (starting at 0). 130 * @return The attribute type as a string, or 131 * null if the index is out of range. 132 * @see #getLength 133 * @see #getType(java.lang.String) 134 */ 135 public abstract String getType (int i); 136 137 138 /** 139 * Return the value of an attribute in the list (by position). 140 * 141 * <p>If the attribute value is a list of tokens (IDREFS, 142 * ENTITIES, or NMTOKENS), the tokens will be concatenated 143 * into a single string separated by whitespace.</p> 144 * 145 * @param i The index of the attribute in the list (starting at 0). 146 * @return The attribute value as a string, or 147 * null if the index is out of range. 148 * @see #getLength 149 * @see #getValue(java.lang.String) 150 */ 151 public abstract String getValue (int i); 152 153 154 155 //////////////////////////////////////////////////////////////////// 157 // Lookup methods. 158 //////////////////////////////////////////////////////////////////// 159 160 161 /** 162 * Return the type of an attribute in the list (by name). 163 * 164 * <p>The return value is the same as the return value for 165 * getType(int).</p> 166 * 167 * <p>If the attribute name has a namespace prefix in the document, 168 * the application must include the prefix here.</p> 169 * 170 * @param name The name of the attribute. 171 * @return The attribute type as a string, or null if no 172 * such attribute exists. 173 * @see #getType(int) 174 */ 175 public abstract String getType (String name); 176 177 178 /** 179 * Return the value of an attribute in the list (by name). 180 * 181 * <p>The return value is the same as the return value for 182 * getValue(int).</p> 183 * 184 * <p>If the attribute name has a namespace prefix in the document, 185 * the application must include the prefix here.</p> 186 * 187 * @param name the name of the attribute to return 188 * @return The attribute value as a string, or null if 189 * no such attribute exists. 190 * @see #getValue(int) 191 */ 192 public abstract String getValue (String name); 193 194 } 195 196 // end of AttributeList.java 197
