001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.project.ant;
043:
044: import java.util.ArrayList;
045: import java.util.List;
046: import java.util.logging.Level;
047: import java.util.logging.Logger;
048: import org.openide.util.Exceptions;
049: import org.w3c.dom.Element;
050: import org.w3c.dom.Node;
051: import org.w3c.dom.NodeList;
052: import org.w3c.dom.Text;
053: import org.xml.sax.ErrorHandler;
054: import org.xml.sax.SAXException;
055: import org.xml.sax.SAXParseException;
056:
057: /**
058: * Utilities relating to Ant projects.
059: * @author Jesse Glick
060: */
061: public class Util {
062:
063: private Util() {
064: }
065:
066: /**
067: * Search for an XML element in the direct children of a parent.
068: * DOM provides a similar method but it does a recursive search
069: * which we do not want. It also gives a node list and we want
070: * only one result.
071: * @param parent a parent element
072: * @param name the intended local name
073: * @param namespace the intended namespace
074: * @return the one child element with that name, or null if none or more than one
075: */
076: public static Element findElement(Element parent, String name,
077: String namespace) {
078: Element result = null;
079: NodeList l = parent.getChildNodes();
080: int len = l.getLength();
081: for (int i = 0; i < len; i++) {
082: if (l.item(i).getNodeType() == Node.ELEMENT_NODE) {
083: Element el = (Element) l.item(i);
084: if (name.equals(el.getLocalName())
085: && namespace.equals(el.getNamespaceURI())) {
086: if (result == null) {
087: result = el;
088: } else {
089: return null;
090: }
091: }
092: }
093: }
094: return result;
095: }
096:
097: /**
098: * Extract nested text from an element.
099: * Currently does not handle coalescing text nodes, CDATA sections, etc.
100: * @param parent a parent element
101: * @return the nested text, or null if none was found
102: */
103: public static String findText(Element parent) {
104: NodeList l = parent.getChildNodes();
105: for (int i = 0; i < l.getLength(); i++) {
106: if (l.item(i).getNodeType() == Node.TEXT_NODE) {
107: Text text = (Text) l.item(i);
108: return text.getNodeValue();
109: }
110: }
111: return null;
112: }
113:
114: /**
115: * Find all direct child elements of an element.
116: * More useful than {@link Element#getElementsByTagNameNS} because it does
117: * not recurse into recursive child elements.
118: * Children which are all-whitespace text nodes are ignored; others cause
119: * an exception to be thrown.
120: * @param parent a parent element in a DOM tree
121: * @return a list of direct child elements (may be empty)
122: * @throws IllegalArgumentException if there are non-element children besides whitespace
123: */
124: public static List<Element> findSubElements(Element parent)
125: throws IllegalArgumentException {
126: NodeList l = parent.getChildNodes();
127: List<Element> elements = new ArrayList<Element>(l.getLength());
128: for (int i = 0; i < l.getLength(); i++) {
129: Node n = l.item(i);
130: if (n.getNodeType() == Node.ELEMENT_NODE) {
131: elements.add((Element) n);
132: } else if (n.getNodeType() == Node.TEXT_NODE) {
133: String text = ((Text) n).getNodeValue();
134: if (text.trim().length() > 0) {
135: throw new IllegalArgumentException(
136: "non-ws text encountered in " + parent
137: + ": " + text); // NOI18N
138: }
139: } else if (n.getNodeType() == Node.COMMENT_NODE) {
140: // skip
141: } else {
142: throw new IllegalArgumentException(
143: "unexpected non-element child of " + parent
144: + ": " + n); // NOI18N
145: }
146: }
147: return elements;
148: }
149:
150: /**
151: * Create an XML error handler that rethrows errors and fatal errors and logs warnings.
152: * @return a standard error handler
153: */
154: public static ErrorHandler defaultErrorHandler() {
155: return new ErrHandler();
156: }
157:
158: private static final class ErrHandler implements ErrorHandler {
159:
160: public ErrHandler() {
161: }
162:
163: private void annotate(SAXParseException exception)
164: throws SAXException {
165: Exceptions.attachMessage(exception, "Occurred at: "
166: + exception.getSystemId() + ":"
167: + exception.getLineNumber()); // NOI18N
168: }
169:
170: public void fatalError(SAXParseException exception)
171: throws SAXException {
172: annotate(exception);
173: throw exception;
174: }
175:
176: public void error(SAXParseException exception)
177: throws SAXException {
178: annotate(exception);
179: throw exception;
180: }
181:
182: public void warning(SAXParseException exception)
183: throws SAXException {
184: annotate(exception);
185: Logger.getLogger(Util.class.getName()).log(Level.INFO,
186: null, exception);
187: }
188:
189: }
190:
191: }
|