org.netbeans.modules.java.j2seproject.J2SEProjectUtil Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.netbeans.modules.java.j2seproject;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Map;
import java.util.Map.Entry;
import java.util.logging.Logger;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.java.classpath.ClassPath;
import org.netbeans.api.java.source.BuildArtifactMapper;
import org.netbeans.api.project.Project;
import org.netbeans.modules.java.api.common.SourceRoots;
import org.netbeans.modules.java.api.common.project.ProjectProperties;
import org.netbeans.spi.project.support.ant.GeneratedFilesHelper;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.util.Parameters;
/**
* Miscellaneous utilities for the j2seproject module.
* @author Jiri Rechtacek
*/
public class J2SEProjectUtil {
private static final String MODULE_INFO_JAVA = "module-info.java"; //NOI18N
private static final String[] BREAKABLE_PROPERTIES = {
ProjectProperties.JAVAC_CLASSPATH,
ProjectProperties.RUN_CLASSPATH,
ProjectProperties.DEBUG_CLASSPATH,
ProjectProperties.JAVAC_TEST_CLASSPATH,
ProjectProperties.RUN_TEST_CLASSPATH,
ProjectProperties.DEBUG_TEST_CLASSPATH,
ProjectProperties.ENDORSED_CLASSPATH,
ProjectProperties.JAVAC_MODULEPATH,
ProjectProperties.RUN_MODULEPATH,
ProjectProperties.DEBUG_MODULEPATH,
ProjectProperties.JAVAC_TEST_MODULEPATH,
ProjectProperties.RUN_TEST_MODULEPATH,
ProjectProperties.DEBUG_TEST_MODULEPATH
};
private static final Logger LOG = Logger.getLogger(J2SEProjectUtil.class.getName());
private J2SEProjectUtil () {}
/**
* Returns the property value evaluated by J2SEProject's PropertyEvaluator.
*
* @param p project
* @param value of property
* @return evaluated value of given property or null if the property not set or
* if the project doesn't provide AntProjectHelper
*/
public static Object getEvaluatedProperty(Project p, String value) {
if (value == null) {
return null;
}
J2SEProject j2seprj = p.getLookup().lookup(J2SEProject.class);
if (j2seprj != null) {
return j2seprj.evaluator().evaluate(value);
} else {
return null;
}
}
/**
* Creates an URL of a classpath or sourcepath root
* For the existing directory it returns the URL obtained from {@link File#toUri()}
* For archive file it returns an URL of the root of the archive file
* For non existing directory it fixes the ending '/'
* @param root the file of a root
* @param offset a path relative to the root file or null (eg. src/ for jar:file:///lib.jar!/src/)"
* @return an URL of the root
* @throws MalformedURLException if the URL cannot be created
*/
public static URL getRootURL (File root, String offset) throws MalformedURLException {
URL url = FileUtil.urlForArchiveOrDir(root);
if (url == null) {
throw new IllegalArgumentException(root.getAbsolutePath());
}
if (offset != null) {
assert offset.endsWith("/"); //NOI18N
url = new URL(url.toExternalForm() + offset); // NOI18N
}
return url;
}
public static String getBuildXmlName (final J2SEProject project) {
assert project != null;
String buildScriptPath = project.evaluator().getProperty(ProjectProperties.BUILD_SCRIPT);
if (buildScriptPath == null) {
buildScriptPath = GeneratedFilesHelper.BUILD_XML_PATH;
}
return buildScriptPath;
}
public static FileObject getBuildXml (final J2SEProject project) {
return project.getProjectDirectory().getFileObject (getBuildXmlName(project));
}
public static boolean isCompileOnSaveSupported(final J2SEProject project) {
Parameters.notNull("project", project);
final Map props = project.evaluator().getProperties();
if (props == null) {
LOG.warning("PropertyEvaluator mapping could not be computed (e.g. due to a circular definition)"); //NOI18N
}
else {
for (Entry e : props.entrySet()) {
if (e.getKey().startsWith(ProjectProperties.COMPILE_ON_SAVE_UNSUPPORTED_PREFIX)) {
if (e.getValue() != null && Boolean.valueOf(e.getValue())) {
return false;
}
}
}
}
return BuildArtifactMapper.isCompileOnSaveSupported();
}
public static boolean isCompileOnSaveEnabled(final J2SEProject project) {
String compileOnSaveProperty = project.evaluator().getProperty(ProjectProperties.COMPILE_ON_SAVE);
return (compileOnSaveProperty != null && Boolean.valueOf(compileOnSaveProperty)) && J2SEProjectUtil.isCompileOnSaveSupported(project);
}
/**
* Returns true when value is ant true|on|yes
* @param value to be checked
* @return boolean
*/
public static boolean isTrue(final String param) {
return "true".equalsIgnoreCase(param) || //NOI18N
"yes".equalsIgnoreCase(param) || //NOI18N
"on".equalsIgnoreCase(param); //NOI18N
}
/**
* Creates reference to property.
* @param propertyName the name of property
* @param lastEntry if true, the path separator is not added
* @return the reference
*/
public static String ref(
@NonNull final String propertyName,
final boolean lastEntry) {
return String.format(
"${%s}%s", //NOI18N
propertyName,
lastEntry ? "" : ":"); //NOI18N
}
/**
* Returns a list of property names which need to be tested for broken references.
* @param project to return property names for
* @return the list of breakable properties
*/
public static String[] getBreakableProperties(@NonNull final J2SEProject project) {
SourceRoots roots = project.getSourceRoots();
String[] srcRootProps = roots.getRootProperties();
roots = project.getTestSourceRoots();
String[] testRootProps = roots.getRootProperties();
String[] result = new String [BREAKABLE_PROPERTIES.length + srcRootProps.length + testRootProps.length];
System.arraycopy(BREAKABLE_PROPERTIES, 0, result, 0, BREAKABLE_PROPERTIES.length);
System.arraycopy(srcRootProps, 0, result, BREAKABLE_PROPERTIES.length, srcRootProps.length);
System.arraycopy(testRootProps, 0, result, BREAKABLE_PROPERTIES.length + srcRootProps.length, testRootProps.length);
return result;
}
public static boolean hasModuleInfo(@NonNull final SourceRoots roots) {
ClassPath scp = null;
for (FileObject root : roots.getRoots()) {
FileObject mInfo = J2SEProjectUtil.getModuleInfo(root);
if (mInfo != null) {
if (scp == null) {
scp = ClassPath.getClassPath(root, ClassPath.SOURCE);
}
if (scp.contains(mInfo)) {
return true;
}
}
}
return false;
}
@NonNull
public static File getModuleInfo(@NonNull final File root) {
return new File(root, MODULE_INFO_JAVA);
}
@CheckForNull
public static FileObject getModuleInfo(@NonNull final FileObject root) {
return root.getFileObject(MODULE_INFO_JAVA);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy