org.codehaus.mevenide.netbeans.queries.MavenForBinaryQueryImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nb-project Show documentation
Show all versions of nb-project Show documentation
Implementation of a Netbeans project backed by Maven2 POM files.
The newest version!
/* ==========================================================================
* Copyright 2005 Mevenide Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =========================================================================
*/
package org.codehaus.mevenide.netbeans.queries;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.apache.maven.model.Build;
import org.apache.maven.project.MavenProject;
import org.codehaus.mevenide.netbeans.NbMavenProject;
import org.codehaus.mevenide.netbeans.api.ProjectURLWatcher;
import org.netbeans.api.java.queries.JavadocForBinaryQuery;
import org.netbeans.api.java.queries.SourceForBinaryQuery;
import org.netbeans.spi.java.queries.JavadocForBinaryQueryImplementation;
import org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation;
import org.openide.ErrorManager;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
/**
* SourceForBinary and JavadocForBinary query impls.
* @author Milos Kleint ([email protected])
*/
public class MavenForBinaryQueryImpl implements SourceForBinaryQueryImplementation,
JavadocForBinaryQueryImplementation {
private NbMavenProject project;
private final HashMap map;
/** Creates a new instance of MavenSourceForBinaryQueryImpl */
public MavenForBinaryQueryImpl(NbMavenProject proj) {
project = proj;
map = new HashMap();
ProjectURLWatcher.addPropertyChangeListener(proj, new PropertyChangeListener() {
public void propertyChange(PropertyChangeEvent event) {
if (NbMavenProject.PROP_PROJECT.equals(event.getPropertyName())) {
synchronized (map) {
for (BinResult res : map.values()) {
if (!Arrays.equals(res.getCached(), res.getRoots())) {
res.fireChanged();
}
}
}
}
}
});
}
/**
* Returns the source root(s) for a given binary root.
*
* Any absolute URL may be used but typically it will use the file
* protocol for directory entries and jar protocol for JAR entries
* (e.g. jar:file:/tmp/foo.jar!/).
*
* @param binaryRoot the class path root of Java class files
* @return a list of source roots; may be empty but not null
*/
public SourceForBinaryQuery.Result findSourceRoots(URL url) {
synchronized (map) {
BinResult toReturn = map.get(url.toString());
if (toReturn != null) {
return toReturn;
}
if (url.getProtocol().equals("jar") && checkURL(url) != -1) { //NOI18N
toReturn = new BinResult(url);
}
if (url.getProtocol().equals("file")) { //NOI18N
int result = checkURL(url);
if (result == 1 || result == 0) {
toReturn = new BinResult(url);
}
}
if (toReturn != null) {
map.put(url.toString(), toReturn);
}
return toReturn;
}
}
/**
* Find any Javadoc corresponding to the given classpath root containing
* Java classes.
*
* Any absolute URL may be used but typically it will use the file
* protocol for directory entries and jar protocol for JAR entries
* (e.g. jar:file:/tmp/foo.jar!/).
*
* @param binaryRoot the class path root of Java class files
* @return a result object encapsulating the roots and permitting changes to
* be listened to, or null if the binary root is not recognized
*/
public JavadocForBinaryQuery.Result findJavadoc(URL url) {
if (checkURL(url) != -1) {
return new DocResult(url);
}
return null;
}
/**
* -1 - not found
* 0 - source
* 1 - test source
*/
private int checkURL(URL url) {
if ("file".equals(url.getProtocol())) { //NOI18N
// true for directories.
try {
MavenProject proj = project.getOriginalMavenProject();
if (proj != null) {
Build build = proj.getBuild();
if (build != null && build.getOutputDirectory() != null) {
File src = FileUtil.normalizeFile(new File(build.getOutputDirectory()));
URL srcUrl = src.toURI().toURL();
if (!srcUrl.toExternalForm().endsWith("/")) { //NOI18N
srcUrl = new URL(srcUrl.toExternalForm() + "/"); //NOI18N
}
if (url.equals(srcUrl)) {
return 0;
}
File test = FileUtil.normalizeFile(new File(build.getTestOutputDirectory()));
// can be null in some obscrure cases.
URL testsrcUrl = test.toURI().toURL();
if (!testsrcUrl.toExternalForm().endsWith("/")) { //NOI18N
testsrcUrl = new URL(testsrcUrl.toExternalForm() + "/"); //NOI18N
}
if (url.equals(testsrcUrl)) {
return 1;
}
}
}
} catch (MalformedURLException exc) {
ErrorManager.getDefault().notify(exc);
}
return -1;
}
if ("jar".equals(url.getProtocol()) //NOI18N
&& !Boolean.getBoolean("mevenide.projectLinksDisable")) { //possible fix for MEVENIDE-535 //NOI18N
URL binRoot = FileUtil.getArchiveFile(url);
File file = new File(URI.create(binRoot.toString()));
String filepath = file.getAbsolutePath().replace('\\', '/'); //NOI18N
String path = project.getArtifactRelativeRepositoryPath();
return filepath.endsWith(path) ? 0 : -1;
}
return -1;
}
private FileObject[] getSrcRoot() {
Collection toReturn = new ArrayList();
List srcRoots = project.getOriginalMavenProject().getCompileSourceRoots();
Iterator it = srcRoots.iterator();
while (it.hasNext()) {
String item = (String)it.next();
FileObject fo = FileUtil.toFileObject(FileUtil.normalizeFile(new File(item)));
if (fo != null) {
toReturn.add(fo);
}
}
URI[] genRoots = project.getGeneratedSourceRoots();
for (int i = 0; i < genRoots.length; i++) {
FileObject fo = FileUtil.toFileObject(FileUtil.normalizeFile(new File(genRoots[i])));
if (fo != null) {
toReturn.add(fo);
}
}
URI[] res = project.getResources(false);
for (int i = 0; i < res.length; i++) {
FileObject fo = FileUtil.toFileObject(new File(res[i]));
if (fo != null) {
toReturn.add(fo);
}
}
return toReturn.toArray(new FileObject[toReturn.size()]);
}
private FileObject[] getTestSrcRoot() {
Collection toReturn = new ArrayList();
List srcRoots = project.getOriginalMavenProject().getTestCompileSourceRoots();
Iterator it = srcRoots.iterator();
while (it.hasNext()) {
String item = (String)it.next();
FileObject fo = FileUtil.toFileObject(FileUtil.normalizeFile(new File(item)));
if (fo != null) {
toReturn.add(fo);
}
}
URI[] res = project.getResources(true);
for (int i = 0; i < res.length; i++) {
FileObject fo = FileUtil.toFileObject(new File(res[i]));
if (fo != null) {
toReturn.add(fo);
}
}
return toReturn.toArray(new FileObject[toReturn.size()]);
}
private URL[] getJavadocRoot() {
//TODO shall we delegate to "possibly" generated javadoc in project or in site?
return new URL[0];
}
private class BinResult implements SourceForBinaryQuery.Result {
private URL url;
private final List listeners;
private FileObject[] results;
private FileObject[] cached = null;
public BinResult(URL urlParam) {
url = urlParam;
listeners = new ArrayList();
}
public FileObject[] getRoots() {
int xxx = checkURL(url);
if (xxx == 0) {
results = getSrcRoot();
} else if (xxx == 1) {
results = getTestSrcRoot();
} else {
results = new FileObject[0];
}
// System.out.println("src bin result for =" + url + " length=" + results.length);
cached = results;
return results;
}
public FileObject[] getCached() {
return cached;
}
public void addChangeListener(ChangeListener changeListener) {
synchronized (listeners) {
listeners.add(changeListener);
}
}
public void removeChangeListener(ChangeListener changeListener) {
synchronized (listeners) {
listeners.remove(changeListener);
}
}
void fireChanged() {
List lists = new ArrayList();
synchronized(listeners) {
lists.addAll(listeners);
}
for (ChangeListener listen : lists) {
listen.stateChanged(new ChangeEvent(this));
}
}
}
private class DocResult implements JavadocForBinaryQuery.Result {
private URL url;
private URL[] results;
private List listeners;
public DocResult(URL urlParam) {
url = urlParam;
listeners = new ArrayList();
}
public void addChangeListener(ChangeListener changeListener) {
synchronized (listeners) {
listeners.add(changeListener);
}
}
public void removeChangeListener(ChangeListener changeListener) {
synchronized (listeners) {
listeners.remove(changeListener);
}
}
void fireChanged() {
List lists = new ArrayList();
synchronized(listeners) {
lists.addAll(listeners);
}
for (ChangeListener listen : lists) {
listen.stateChanged(new ChangeEvent(this));
}
}
public java.net.URL[] getRoots() {
if (checkURL(url) != -1) {
results = getJavadocRoot();
} else {
results = new URL[0];
}
return results;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy