duke@1: /*
jjg@1357: * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1:
jjg@1357: import java.io.*;
jjg@1357: import java.util.*;
jjg@1357:
jjg@1357: import javax.xml.parsers.*;
jjg@1357:
jjg@1357: import org.xml.sax.*;
jjg@1357: import org.xml.sax.helpers.DefaultHandler;
jjg@1357:
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1:
duke@1: /**
duke@1: * Parse the XML that specified the order of operation for the builders. This
duke@1: * Parser uses SAX parsing.
duke@1: *
jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
jjg@1359: *
duke@1: * @author Jamie Ho
duke@1: * @since 1.5
duke@1: * @see SAXParser
duke@1: */
duke@1: public class LayoutParser extends DefaultHandler {
duke@1:
duke@1: /**
duke@1: * The map of XML elements that have been parsed.
duke@1: */
jjg@589: private Map xmlElementsMap;
jjg@589: private XMLNode currentNode;
duke@1: private Configuration configuration;
duke@1: private static LayoutParser instance;
duke@1: private String currentRoot;
duke@1: private boolean isParsing;
duke@1:
duke@1: /**
duke@1: * This class is a singleton.
duke@1: */
duke@1: private LayoutParser(Configuration configuration) {
jjg@589: xmlElementsMap = new HashMap();
duke@1: this.configuration = configuration;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return an instance of the BuilderXML.
duke@1: *
duke@1: * @param configuration the current configuration of the doclet.
duke@1: * @return an instance of the BuilderXML.
duke@1: */
duke@1: public static LayoutParser getInstance(Configuration configuration) {
duke@1: if (instance == null) {
duke@1: instance = new LayoutParser(configuration);
duke@1: }
duke@1: return instance;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Parse the XML specifying the layout of the documentation.
duke@1: *
bpatel@766: * @return the list of XML elements parsed.
duke@1: */
jjg@589: public XMLNode parseXML(String root) {
duke@1: if (xmlElementsMap.containsKey(root)) {
mcimadamore@184: return xmlElementsMap.get(root);
duke@1: }
duke@1: try {
duke@1: currentRoot = root;
duke@1: isParsing = false;
duke@1: SAXParserFactory factory = SAXParserFactory.newInstance();
duke@1: SAXParser saxParser = factory.newSAXParser();
duke@1: InputStream in = configuration.getBuilderXML();
duke@1: saxParser.parse(in, this);
jjg@589: return xmlElementsMap.get(root);
duke@1: } catch (Throwable t) {
duke@1: t.printStackTrace();
duke@1: throw new DocletAbortException();
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
jjg@589: @Override
duke@1: public void startElement(String namespaceURI, String sName, String qName,
duke@1: Attributes attrs)
duke@1: throws SAXException {
duke@1: if (isParsing || qName.equals(currentRoot)) {
duke@1: isParsing = true;
jjg@589: currentNode = new XMLNode(currentNode, qName);
jjg@589: for (int i = 0; i < attrs.getLength(); i++)
jjg@589: currentNode.attrs.put(attrs.getLocalName(i), attrs.getValue(i));
jjg@589: if (qName.equals(currentRoot))
jjg@589: xmlElementsMap.put(qName, currentNode);
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
jjg@589: @Override
duke@1: public void endElement(String namespaceURI, String sName, String qName)
duke@1: throws SAXException {
duke@1: if (! isParsing) {
duke@1: return;
duke@1: }
jjg@589: currentNode = currentNode.parent;
duke@1: isParsing = ! qName.equals(currentRoot);
duke@1: }
duke@1: }