19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.sax; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.Locator; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.SAXParseException; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.ArrayList; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * An XML element. Provides access to child elements and hooks to listen 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for events related to this element. 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see RootElement 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Element { 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final String uri; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final String localName; 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int depth; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Element parent; 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Children children; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ArrayList<Element> requiredChilden; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean visited; 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StartElementListener startElementListener; 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project EndElementListener endElementListener; 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project EndTextElementListener endTextElementListener; 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element(Element parent, String uri, String localName, int depth) { 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.parent = parent; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.uri = uri; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.localName = localName; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.depth = depth; 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the child element with the given name. Uses an empty string as the 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * namespace. 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Element getChild(String localName) { 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getChild("", localName); 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the child element with the given name. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Element getChild(String uri, String localName) { 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (endTextElementListener != null) { 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("This element already has an end" 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + " text element listener. It cannot have children."); 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (children == null) { 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project children = new Children(); 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return children.getOrCreate(this, uri, localName); 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the child element with the given name. Uses an empty string as the 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * namespace. We will throw a {@link org.xml.sax.SAXException} at parsing 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * time if the specified child is missing. This helps you ensure that your 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * listeners are called. 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Element requireChild(String localName) { 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return requireChild("", localName); 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the child element with the given name. We will throw a 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link org.xml.sax.SAXException} at parsing time if the specified child 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is missing. This helps you ensure that your listeners are called. 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Element requireChild(String uri, String localName) { 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element child = getChild(uri, localName); 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (requiredChilden == null) { 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project requiredChilden = new ArrayList<Element>(); 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project requiredChilden.add(child); 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!requiredChilden.contains(child)) { 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project requiredChilden.add(child); 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return child; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets start and end element listeners at the same time. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setElementListener(ElementListener elementListener) { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setStartElementListener(elementListener); 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setEndElementListener(elementListener); 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets start and end text element listeners at the same time. 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setTextElementListener(TextElementListener elementListener) { 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setStartElementListener(elementListener); 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setEndTextElementListener(elementListener); 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets a listener for the start of this element. 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setStartElementListener( 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StartElementListener startElementListener) { 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (this.startElementListener != null) { 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Start element listener has already been set."); 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.startElementListener = startElementListener; 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets a listener for the end of this element. 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setEndElementListener(EndElementListener endElementListener) { 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (this.endElementListener != null) { 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "End element listener has already been set."); 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.endElementListener = endElementListener; 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets a listener for the end of this text element. 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setEndTextElementListener( 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project EndTextElementListener endTextElementListener) { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (this.endTextElementListener != null) { 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "End text element listener has already been set."); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (children != null) { 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("This element already has children." 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + " It cannot have an end text element listener."); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.endTextElementListener = endTextElementListener; 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return toString(uri, localName); 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static String toString(String uri, String localName) { 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return "'" + (uri.equals("") ? localName : uri + ":" + localName) + "'"; 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clears flags on required children. 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void resetRequiredChildren() { 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ArrayList<Element> requiredChildren = this.requiredChilden; 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (requiredChildren != null) { 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = requiredChildren.size() - 1; i >= 0; i--) { 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project requiredChildren.get(i).visited = false; 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Throws an exception if a required child was not present. 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void checkRequiredChildren(Locator locator) throws SAXParseException { 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ArrayList<Element> requiredChildren = this.requiredChilden; 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (requiredChildren != null) { 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = requiredChildren.size() - 1; i >= 0; i--) { 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element child = requiredChildren.get(i); 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!child.visited) { 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new BadXmlException( 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Element named " + this + " is missing required" 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + " child element named " 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + child + ".", locator); 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 203