src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/LayoutParser.java

Fri, 26 Oct 2012 13:10:56 -0700

author
jjg
date
Fri, 26 Oct 2012 13:10:56 -0700
changeset 1376
217c265158fe
parent 1359
25e14ad23cef
child 1410
bfec2a1cc869
permissions
-rw-r--r--

8001219: Clean up use of URLs in javadoc Extern class
Reviewed-by: darcy

duke@1 1 /*
jjg@1357 2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25 package com.sun.tools.doclets.internal.toolkit.builders;
duke@1 26
jjg@1357 27 import java.io.*;
jjg@1357 28 import java.util.*;
jjg@1357 29
jjg@1357 30 import javax.xml.parsers.*;
jjg@1357 31
jjg@1357 32 import org.xml.sax.*;
jjg@1357 33 import org.xml.sax.helpers.DefaultHandler;
jjg@1357 34
duke@1 35 import com.sun.tools.doclets.internal.toolkit.*;
duke@1 36 import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1 37
duke@1 38 /**
duke@1 39 * Parse the XML that specified the order of operation for the builders. This
duke@1 40 * Parser uses SAX parsing.
duke@1 41 *
jjg@1359 42 * <p><b>This is NOT part of any supported API.
jjg@1359 43 * If you write code that depends on this, you do so at your own risk.
jjg@1359 44 * This code and its internal interfaces are subject to change or
jjg@1359 45 * deletion without notice.</b>
jjg@1359 46 *
duke@1 47 * @author Jamie Ho
duke@1 48 * @since 1.5
duke@1 49 * @see SAXParser
duke@1 50 */
duke@1 51 public class LayoutParser extends DefaultHandler {
duke@1 52
duke@1 53 /**
duke@1 54 * The map of XML elements that have been parsed.
duke@1 55 */
jjg@589 56 private Map<String,XMLNode> xmlElementsMap;
jjg@589 57 private XMLNode currentNode;
duke@1 58 private Configuration configuration;
duke@1 59 private static LayoutParser instance;
duke@1 60 private String currentRoot;
duke@1 61 private boolean isParsing;
duke@1 62
duke@1 63 /**
duke@1 64 * This class is a singleton.
duke@1 65 */
duke@1 66 private LayoutParser(Configuration configuration) {
jjg@589 67 xmlElementsMap = new HashMap<String,XMLNode>();
duke@1 68 this.configuration = configuration;
duke@1 69 }
duke@1 70
duke@1 71 /**
duke@1 72 * Return an instance of the BuilderXML.
duke@1 73 *
duke@1 74 * @param configuration the current configuration of the doclet.
duke@1 75 * @return an instance of the BuilderXML.
duke@1 76 */
duke@1 77 public static LayoutParser getInstance(Configuration configuration) {
duke@1 78 if (instance == null) {
duke@1 79 instance = new LayoutParser(configuration);
duke@1 80 }
duke@1 81 return instance;
duke@1 82 }
duke@1 83
duke@1 84 /**
duke@1 85 * Parse the XML specifying the layout of the documentation.
duke@1 86 *
bpatel@766 87 * @return the list of XML elements parsed.
duke@1 88 */
jjg@589 89 public XMLNode parseXML(String root) {
duke@1 90 if (xmlElementsMap.containsKey(root)) {
mcimadamore@184 91 return xmlElementsMap.get(root);
duke@1 92 }
duke@1 93 try {
duke@1 94 currentRoot = root;
duke@1 95 isParsing = false;
duke@1 96 SAXParserFactory factory = SAXParserFactory.newInstance();
duke@1 97 SAXParser saxParser = factory.newSAXParser();
duke@1 98 InputStream in = configuration.getBuilderXML();
duke@1 99 saxParser.parse(in, this);
jjg@589 100 return xmlElementsMap.get(root);
duke@1 101 } catch (Throwable t) {
duke@1 102 t.printStackTrace();
duke@1 103 throw new DocletAbortException();
duke@1 104 }
duke@1 105 }
duke@1 106
duke@1 107 /**
duke@1 108 * {@inheritDoc}
duke@1 109 */
jjg@589 110 @Override
duke@1 111 public void startElement(String namespaceURI, String sName, String qName,
duke@1 112 Attributes attrs)
duke@1 113 throws SAXException {
duke@1 114 if (isParsing || qName.equals(currentRoot)) {
duke@1 115 isParsing = true;
jjg@589 116 currentNode = new XMLNode(currentNode, qName);
jjg@589 117 for (int i = 0; i < attrs.getLength(); i++)
jjg@589 118 currentNode.attrs.put(attrs.getLocalName(i), attrs.getValue(i));
jjg@589 119 if (qName.equals(currentRoot))
jjg@589 120 xmlElementsMap.put(qName, currentNode);
duke@1 121 }
duke@1 122 }
duke@1 123
duke@1 124 /**
duke@1 125 * {@inheritDoc}
duke@1 126 */
jjg@589 127 @Override
duke@1 128 public void endElement(String namespaceURI, String sName, String qName)
duke@1 129 throws SAXException {
duke@1 130 if (! isParsing) {
duke@1 131 return;
duke@1 132 }
jjg@589 133 currentNode = currentNode.parent;
duke@1 134 isParsing = ! qName.equals(currentRoot);
duke@1 135 }
duke@1 136 }

mercurial