Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/LayoutParser.java@4177f5bdd189 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/LayoutParser.java
Fri, 18 Jun 2010 21:13:56 -0700
- author
- jjg
- date
- Fri, 18 Jun 2010 21:13:56 -0700
- changeset 589
- 4177f5bdd189
- parent 554
- 9d9f26857129
- child 766
- 90af8d87741f
- permissions
- -rw-r--r--
6961178: Allow doclet.xml to contain XML attributes
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2003, 2008, 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 | |
| duke@1 | 27 | import com.sun.tools.doclets.internal.toolkit.*; |
| duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| duke@1 | 29 | import java.io.*; |
| duke@1 | 30 | import java.util.*; |
| duke@1 | 31 | import org.xml.sax.*; |
| duke@1 | 32 | import org.xml.sax.helpers.DefaultHandler; |
| duke@1 | 33 | import javax.xml.parsers.*; |
| duke@1 | 34 | |
| duke@1 | 35 | /** |
| duke@1 | 36 | * Parse the XML that specified the order of operation for the builders. This |
| duke@1 | 37 | * Parser uses SAX parsing. |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| duke@1 | 40 | * @since 1.5 |
| duke@1 | 41 | * @see SAXParser |
| duke@1 | 42 | */ |
| duke@1 | 43 | public class LayoutParser extends DefaultHandler { |
| duke@1 | 44 | |
| duke@1 | 45 | /** |
| duke@1 | 46 | * The map of XML elements that have been parsed. |
| duke@1 | 47 | */ |
| jjg@589 | 48 | private Map<String,XMLNode> xmlElementsMap; |
| jjg@589 | 49 | private XMLNode currentNode; |
| duke@1 | 50 | private Configuration configuration; |
| duke@1 | 51 | private static LayoutParser instance; |
| duke@1 | 52 | private String currentRoot; |
| duke@1 | 53 | private boolean isParsing; |
| duke@1 | 54 | |
| duke@1 | 55 | /** |
| duke@1 | 56 | * This class is a singleton. |
| duke@1 | 57 | */ |
| duke@1 | 58 | private LayoutParser(Configuration configuration) { |
| jjg@589 | 59 | xmlElementsMap = new HashMap<String,XMLNode>(); |
| duke@1 | 60 | this.configuration = configuration; |
| duke@1 | 61 | } |
| duke@1 | 62 | |
| duke@1 | 63 | /** |
| duke@1 | 64 | * Return an instance of the BuilderXML. |
| duke@1 | 65 | * |
| duke@1 | 66 | * @param configuration the current configuration of the doclet. |
| duke@1 | 67 | * @return an instance of the BuilderXML. |
| duke@1 | 68 | */ |
| duke@1 | 69 | public static LayoutParser getInstance(Configuration configuration) { |
| duke@1 | 70 | if (instance == null) { |
| duke@1 | 71 | instance = new LayoutParser(configuration); |
| duke@1 | 72 | } |
| duke@1 | 73 | return instance; |
| duke@1 | 74 | } |
| duke@1 | 75 | |
| duke@1 | 76 | /** |
| duke@1 | 77 | * Parse the XML specifying the layout of the documentation. |
| duke@1 | 78 | * |
| duke@1 | 79 | * @return List the list of XML elements parsed. |
| duke@1 | 80 | */ |
| jjg@589 | 81 | public XMLNode parseXML(String root) { |
| duke@1 | 82 | if (xmlElementsMap.containsKey(root)) { |
| mcimadamore@184 | 83 | return xmlElementsMap.get(root); |
| duke@1 | 84 | } |
| duke@1 | 85 | try { |
| duke@1 | 86 | currentRoot = root; |
| duke@1 | 87 | isParsing = false; |
| duke@1 | 88 | SAXParserFactory factory = SAXParserFactory.newInstance(); |
| duke@1 | 89 | SAXParser saxParser = factory.newSAXParser(); |
| duke@1 | 90 | InputStream in = configuration.getBuilderXML(); |
| duke@1 | 91 | saxParser.parse(in, this); |
| jjg@589 | 92 | return xmlElementsMap.get(root); |
| duke@1 | 93 | } catch (Throwable t) { |
| duke@1 | 94 | t.printStackTrace(); |
| duke@1 | 95 | throw new DocletAbortException(); |
| duke@1 | 96 | } |
| duke@1 | 97 | } |
| duke@1 | 98 | |
| duke@1 | 99 | /** |
| duke@1 | 100 | * {@inheritDoc} |
| duke@1 | 101 | */ |
| jjg@589 | 102 | @Override |
| duke@1 | 103 | public void startElement(String namespaceURI, String sName, String qName, |
| duke@1 | 104 | Attributes attrs) |
| duke@1 | 105 | throws SAXException { |
| duke@1 | 106 | if (isParsing || qName.equals(currentRoot)) { |
| duke@1 | 107 | isParsing = true; |
| jjg@589 | 108 | currentNode = new XMLNode(currentNode, qName); |
| jjg@589 | 109 | for (int i = 0; i < attrs.getLength(); i++) |
| jjg@589 | 110 | currentNode.attrs.put(attrs.getLocalName(i), attrs.getValue(i)); |
| jjg@589 | 111 | if (qName.equals(currentRoot)) |
| jjg@589 | 112 | xmlElementsMap.put(qName, currentNode); |
| duke@1 | 113 | } |
| duke@1 | 114 | } |
| duke@1 | 115 | |
| duke@1 | 116 | /** |
| duke@1 | 117 | * {@inheritDoc} |
| duke@1 | 118 | */ |
| jjg@589 | 119 | @Override |
| duke@1 | 120 | public void endElement(String namespaceURI, String sName, String qName) |
| duke@1 | 121 | throws SAXException { |
| duke@1 | 122 | if (! isParsing) { |
| duke@1 | 123 | return; |
| duke@1 | 124 | } |
| jjg@589 | 125 | currentNode = currentNode.parent; |
| duke@1 | 126 | isParsing = ! qName.equals(currentRoot); |
| duke@1 | 127 | } |
| duke@1 | 128 | } |
