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

Thu, 02 Oct 2008 19:58:40 -0700

author
xdono
date
Thu, 02 Oct 2008 19:58:40 -0700
changeset 117
24a47c3062fe
parent 74
5a9172b251dd
child 184
905e151a185a
permissions
-rw-r--r--

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

duke@1 1 /*
xdono@117 2 * Copyright 2003-2008 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any 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@74 48 private Map<String,List<Object>> xmlElementsMap;
duke@1 49
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@74 59 xmlElementsMap = new HashMap<String,List<Object>>();
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 */
duke@1 81 public List parseXML(String root) {
duke@1 82 if (xmlElementsMap.containsKey(root)) {
duke@1 83 return (List) xmlElementsMap.get(root);
duke@1 84 }
duke@1 85 try {
jjg@74 86 List<Object> xmlElements = new ArrayList<Object>();
duke@1 87 xmlElementsMap.put(root, xmlElements);
duke@1 88 currentRoot = root;
duke@1 89 isParsing = false;
duke@1 90 SAXParserFactory factory = SAXParserFactory.newInstance();
duke@1 91 SAXParser saxParser = factory.newSAXParser();
duke@1 92 InputStream in = configuration.getBuilderXML();
duke@1 93 saxParser.parse(in, this);
duke@1 94 return xmlElements;
duke@1 95 } catch (Throwable t) {
duke@1 96 t.printStackTrace();
duke@1 97 throw new DocletAbortException();
duke@1 98 }
duke@1 99 }
duke@1 100
duke@1 101 /**
duke@1 102 * {@inheritDoc}
duke@1 103 */
duke@1 104 public void startElement(String namespaceURI, String sName, String qName,
duke@1 105 Attributes attrs)
duke@1 106 throws SAXException {
duke@1 107 if (isParsing || qName.equals(currentRoot)) {
duke@1 108 isParsing = true;
jjg@74 109 List<Object> xmlElements = xmlElementsMap.get(currentRoot);
duke@1 110 xmlElements.add(qName);
duke@1 111 }
duke@1 112 }
duke@1 113
duke@1 114 /**
duke@1 115 * {@inheritDoc}
duke@1 116 */
duke@1 117 public void endElement(String namespaceURI, String sName, String qName)
duke@1 118 throws SAXException {
duke@1 119 if (! isParsing) {
duke@1 120 isParsing = false;
duke@1 121 return;
duke@1 122 }
jjg@74 123 List<Object> xmlElements = xmlElementsMap.get(currentRoot);
duke@1 124 if (xmlElements.get(xmlElements.size()-1).equals(qName)) {
duke@1 125 return;
duke@1 126 } else {
jjg@74 127 List<Object> subElements = new ArrayList<Object>();
duke@1 128 int targetIndex = xmlElements.indexOf(qName);
duke@1 129 int size = xmlElements.size();
duke@1 130 for (int i = targetIndex; i < size; i++) {
duke@1 131 subElements.add(xmlElements.get(targetIndex));
duke@1 132 xmlElements.remove(targetIndex);
duke@1 133 }
duke@1 134 //Save the sub elements as a list.
duke@1 135 xmlElements.add(subElements);
duke@1 136 }
duke@1 137 isParsing = ! qName.equals(currentRoot);
duke@1 138 }
duke@1 139 }

mercurial