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-2008 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.web.jspparser;
043:
044: import java.io.PrintWriter;
045: import java.io.StringWriter;
046:
047: import org.openide.filesystems.FileObject;
048: import org.openide.filesystems.FileUtil;
049:
050: /**
051: * Static utilities related to web context stuff - relative paths, relative objects etc.
052: * @author Petr Jiricka
053: */
054: public final class ContextUtil {
055:
056: private ContextUtil() {
057: }
058:
059: /** Returns a message for a given throwable. Optionally includes the throwable
060: * stack trace in the message.
061: * @param throwable throwable for which to construct the message
062: * @param includeStackTrace whether to include a stack trace of the throwable in the message
063: * @return an appropriate message for the throwable
064: */
065: public static String getThrowableMessage(Throwable throwable,
066: boolean includeStackTrace) {
067: if (includeStackTrace) {
068: StringWriter swriter = new StringWriter();
069: PrintWriter pw = new PrintWriter(swriter);
070: throwable.printStackTrace(pw);
071: pw.close();
072: return swriter.toString();
073: }
074: return throwable.getMessage();
075: }
076:
077: /**********************************
078: * Copied over from WebModuleUtils.
079: **********************************
080: */
081:
082: /** Decides whether a given file is in the subtree defined by the given folder.
083: * Similar to <code>org.openide.filesystems.FileUtil.isParentOf (FileObject folder, FileObject fo)</code>,
084: * but also accepts the case that <code>fo == folder</code>
085: */
086: public static boolean isInSubTree(FileObject folder, FileObject fo) {
087: if (fo == folder) {
088: return true;
089: }
090: return FileUtil.isParentOf(folder, fo);
091: }
092:
093: /** Finds a relative resource path between rootFolder and relativeObject.
094: * @return relative path between rootFolder and relativeObject. The returned path
095: * never starts with a '/'. It never ends with a '/'.
096: * @exception IllegalArgumentException if relativeObject is not in rootFolder's tree.
097: */
098: public static String findRelativePath(FileObject rootFolder,
099: FileObject relativeObject) {
100: String rfp = rootFolder.getPath();
101: String rop = relativeObject.getPath();
102: // check that they share the start of the path
103: if (!isInSubTree(rootFolder, relativeObject)) {
104: throw new IllegalArgumentException("" + rootFolder + " / "
105: + relativeObject); // NOI18N
106: }
107: // now really return the result
108: String result = rop.substring(rfp.length());
109: if (result.startsWith("/")) { // NOI18N
110: result = result.substring(1);
111: }
112: return result;
113: }
114:
115: /** Finds a relative context path between rootFolder and relativeObject.
116: * Similar to <code>findRelativePath(FileObject, FileObject)</code>, only
117: * different slash '/' conventions.
118: * @return relative context path between rootFolder and relativeObject. The returned path
119: * always starts with a '/'. It ends with a '/' if the relative object is a directory.
120: * @exception IllegalArgumentException if relativeObject is not in rootFolder's tree.
121: */
122: public static String findRelativeContextPath(FileObject rootFolder,
123: FileObject relativeObject) {
124: String result = "/"
125: + findRelativePath(rootFolder, relativeObject); // NOI18N
126: return relativeObject.isFolder() ? (result + "/") : result; // NOI18N
127: }
128: }
|