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

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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

mercurial