Java tutorial
/* * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ // SAX Attribute List Interface. // http://www.saxproject.org // No warranty; no copyright -- use this as you will. // $Id: AttributeList.java,v 1.3 2004/11/03 22:44:51 jsuttor Exp $ package org.xml.sax; /** * Interface for an element's attribute specifications. * * <blockquote> * <em>This module, both source code and documentation, is in the * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a> * for further information. * </blockquote> * * <p>This is the original SAX1 interface for reporting an element's * attributes. Unlike the new {@link org.xml.sax.Attributes Attributes} * interface, it does not support Namespace-related information. * * <p>When an attribute list is supplied as part of a * {@link org.xml.sax.DocumentHandler#startElement startElement} * event, the list will return valid results only during the * scope of the event; once the event handler returns control * to the parser, the attribute list is invalid. To save a * persistent copy of the attribute list, use the SAX1 * {@link org.xml.sax.helpers.AttributeListImpl AttributeListImpl} * helper class. * * <p>An attribute list includes only attributes that have been * specified or defaulted: #IMPLIED attributes will not be included. * * <p>There are two ways for the SAX application to obtain information * from the AttributeList. First, it can iterate through the entire * list: * * <pre>{@code * public void startElement (String name, AttributeList atts) { * for (int i = 0; i < atts.getLength(); i++) { * String name = atts.getName(i); * String type = atts.getType(i); * String value = atts.getValue(i); * [...] * } * } * }</pre> * * <p>(Note that the result of getLength() will be zero if there * are no attributes.) * * <p>As an alternative, the application can request the value or * type of specific attributes: * * <pre> * public void startElement (String name, AttributeList atts) { * String identifier = atts.getValue("id"); * String label = atts.getValue("label"); * [...] * } * </pre> * * @deprecated This interface has been replaced by the SAX2 * {@link org.xml.sax.Attributes Attributes} * interface, which includes Namespace support. * @since 1.4, SAX 1.0 * @author David Megginson * @see org.xml.sax.DocumentHandler#startElement startElement * @see org.xml.sax.helpers.AttributeListImpl AttributeListImpl */ @Deprecated(since = "1.5") public interface AttributeList { //////////////////////////////////////////////////////////////////// // Iteration methods. //////////////////////////////////////////////////////////////////// /** * Return the number of attributes in this list. * * <p>The SAX parser may provide attributes in any * arbitrary order, regardless of the order in which they were * declared or specified. The number of attributes may be * zero. * * @return The number of attributes in the list. */ public abstract int getLength(); /** * Return the name of an attribute in this list (by position). * * <p>The names must be unique: the SAX parser shall not include the * same attribute twice. Attributes without values (those declared * #IMPLIED without a value specified in the start tag) will be * omitted from the list. * * <p>If the attribute name has a namespace prefix, the prefix * will still be attached. * * @param i The index of the attribute in the list (starting at 0). * @return The name of the indexed attribute, or null * if the index is out of range. * @see #getLength */ public abstract String getName(int i); /** * Return the type of an attribute in the list (by position). * * <p>The attribute type is one of the strings "CDATA", "ID", * "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", * or "NOTATION" (always in upper case). * * <p>If the parser has not read a declaration for the attribute, * or if the parser does not report attribute types, then it must * return the value "CDATA" as stated in the XML 1.0 Recommentation * (clause 3.3.3, "Attribute-Value Normalization"). * * <p>For an enumerated attribute that is not a notation, the * parser will report the type as "NMTOKEN". * * @param i The index of the attribute in the list (starting at 0). * @return The attribute type as a string, or * null if the index is out of range. * @see #getLength * @see #getType(java.lang.String) */ public abstract String getType(int i); /** * Return the value of an attribute in the list (by position). * * <p>If the attribute value is a list of tokens (IDREFS, * ENTITIES, or NMTOKENS), the tokens will be concatenated * into a single string separated by whitespace. * * @param i The index of the attribute in the list (starting at 0). * @return The attribute value as a string, or * null if the index is out of range. * @see #getLength * @see #getValue(java.lang.String) */ public abstract String getValue(int i); //////////////////////////////////////////////////////////////////// // Lookup methods. //////////////////////////////////////////////////////////////////// /** * Return the type of an attribute in the list (by name). * * <p>The return value is the same as the return value for * getType(int). * * <p>If the attribute name has a namespace prefix in the document, * the application must include the prefix here. * * @param name The name of the attribute. * @return The attribute type as a string, or null if no * such attribute exists. * @see #getType(int) */ public abstract String getType(String name); /** * Return the value of an attribute in the list (by name). * * <p>The return value is the same as the return value for * getValue(int). * * <p>If the attribute name has a namespace prefix in the document, * the application must include the prefix here. * * @param name the name of the attribute to return * @return The attribute value as a string, or null if * no such attribute exists. * @see #getValue(int) */ public abstract String getValue(String name); } // end of AttributeList.java