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 Micro//S ystems, Inc. Portions Copyright 1997-2006 Sun
028: * Micro//S ystems, 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: package org.netbeans.spi.debugger.jpda;
042:
043: import java.beans.PropertyChangeListener;
044: import java.io.File;
045: import java.util.Set;
046:
047: /**
048: * Defines source path for debugger. It translates relative path
049: * (like "java/lang/Thread.java", or class name) to url
050: * ("file:///C:/Sources/java/lang/Thread.java"). It allows to define
051: * and modify source path.
052: * All instances of this class should be registerred in
053: * "Meta-inf/debugger/<DebuggerEngine ID>/org.netbeans.spi.debugger.jpda.EngineContextProvider"
054: * files. There should be at least one instance installed.
055: *
056: * @author Maros Sandor, Jan Jancura
057: */
058: public abstract class SourcePathProvider {
059:
060: /** Property name constant. */
061: public static final String PROP_SOURCE_ROOTS = "sourceRoots";
062:
063: /**
064: * Returns relative path (java/lang/Thread.java) for given url
065: * ("file:///C:/Sources/java/lang/Thread.java").
066: *
067: * @param url a url of resource file
068: * @param directorySeparator a directory separator character
069: * @param includeExtension whether the file extension should be included
070: * in the result
071: *
072: * @return relative path
073: */
074: public abstract String getRelativePath(String url,
075: char directorySeparator, boolean includeExtension);
076:
077: /**
078: * Translates a relative path ("java/lang/Thread.java") to url
079: * ("file:///C:/Sources/java/lang/Thread.java"). Uses GlobalPathRegistry
080: * if global == true.
081: *
082: * @param relativePath a relative path (java/lang/Thread.java)
083: * @param global true if global path should be used
084: * @return url
085: */
086: public abstract String getURL(String relativePath, boolean global);
087:
088: /**
089: * Returns the source root (if any) for given url.
090: *
091: * @param url a url of resource file
092: *
093: * @return the source root or <code>null</code> when no source root was found.
094: * @since 2.6
095: */
096: public String getSourceRoot(String url) {
097: return null;
098: }
099:
100: /**
101: * Returns array of source roots.
102: */
103: public abstract String[] getSourceRoots();
104:
105: /**
106: * Sets array of source roots.
107: *
108: * @param sourceRoots a new array of sourceRoots
109: */
110: public abstract void setSourceRoots(String[] sourceRoots);
111:
112: /**
113: * Returns set of original source roots.
114: *
115: * @return set of original source roots
116: */
117: public abstract String[] getOriginalSourceRoots();
118:
119: /**
120: * Adds property change listener.
121: *
122: * @param l new listener.
123: */
124: public abstract void addPropertyChangeListener(
125: PropertyChangeListener l);
126:
127: /**
128: * Removes property change listener.
129: *
130: * @param l removed listener.
131: */
132: public abstract void removePropertyChangeListener(
133: PropertyChangeListener l);
134: }
|