JavaSourceFolderUtil.java

/*******************************************************************************
 * Copyright (c) 2012-2016 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.ext.java.client.projecttree;

import org.eclipse.che.api.project.shared.dto.ItemReference;
import org.eclipse.che.api.workspace.shared.dto.ProjectConfigDto;
import org.eclipse.che.commons.annotation.Nullable;
import org.eclipse.che.ide.api.app.CurrentProject;
import org.eclipse.che.ide.api.project.node.HasProjectConfig;
import org.eclipse.che.ide.api.project.tree.TreeNode;
import org.eclipse.che.ide.api.project.tree.VirtualFile;
import org.eclipse.che.ide.ext.java.client.project.node.JavaFileNode;
import org.eclipse.che.ide.ext.java.client.project.node.PackageNode;
import org.eclipse.che.ide.ext.java.client.project.node.jar.JarFileNode;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

/**
 * @author Vladyslav Zhukovskii
 * @author Anatoliy Bazko
 */
public class JavaSourceFolderUtil {

    /** Indicates if the specified item is a source folder. */
    public static boolean isSourceFolder(ItemReference item, HasProjectConfig projectNode) {
        if ("folder".equals(item.getType())) {
            String projectBuilder = getProjectBuilder(projectNode);

            if (projectBuilder != null) {
                ProjectConfigDto projectConfig = projectNode.getProjectConfig();
                Map<String, List<String>> attributes = projectConfig.getAttributes();

                final String projectPath = projectConfig.getPath();
                final String itemPath = item.getPath();

                List<String> sourceFolders = attributes.get(projectBuilder + ".source.folder");
                boolean isSrcDir = isSourceFolder(sourceFolders, projectPath, itemPath);

                List<String> testSourceFolders = attributes.get(projectBuilder + ".test.source.folder");
                boolean isTestDir = isSourceFolder(testSourceFolders, projectPath, itemPath);

                return isSrcDir || isTestDir;
            }
        }

        return false;
    }

    private static boolean isSourceFolder(@Null List<String> sourceFolders, String projectPath, String itemPath) {
        projectPath = removeEndingPathSeparator(projectPath);

        if (sourceFolders != null) {
            for (String sourceFolder : sourceFolders) {
                if ((projectPath + addStartingPathSeparator(sourceFolder)).equals(itemPath)) {
                    return true;
                }
            }
        }

        return false;
    }


    /**
     * Returns source folders list of the project to which the specified node belongs.
     * Every path in the returned list starts and ends with separator char /.
     */
    @NotNull
    public static List<String> getSourceFolders(TreeNode<?> node) {
        HasProjectConfig project = node.getProject();
        String projectBuilder = getProjectBuilder(project);

        return doGetSourceFolders(project.getProjectConfig(), projectBuilder);
    }

    /**
     * Returns source folders list of the project.
     * Every path in the returned list starts and ends with separator char /.
     */
    @NotNull
    public static List<String> getSourceFolders(@NotNull CurrentProject project) {
        ProjectConfigDto projectConfig = project.getProjectConfig();
        String projectBuilder = getProjectBuilder(projectConfig.getType());

        return doGetSourceFolders(projectConfig, projectBuilder);
    }

    @NotNull
    private static List<String> doGetSourceFolders(ProjectConfigDto projectConfig, String projectBuilder) {
        List<String> allSourceFolders = new LinkedList<>();

        String projectPath = removeEndingPathSeparator(projectConfig.getPath());
        Map<String, List<String>> attributes = projectConfig.getAttributes();

        List<String> sourceFolders = attributes.get(projectBuilder + ".source.folder");
        if (sourceFolders != null) {
            for (String sourceFolder : sourceFolders) {
                allSourceFolders.add(projectPath + addStartingPathSeparator(sourceFolder) + '/');
            }
        }

        List<String> testSourceFolders = attributes.get(projectBuilder + ".test.source.folder");
        if (testSourceFolders != null) {
            for (String testSourceFolder : testSourceFolders) {
                allSourceFolders.add(projectPath + addStartingPathSeparator(testSourceFolder) + '/');
            }
        }

        return allSourceFolders;
    }

    public static String getFQNForFile(VirtualFile file) {
        String packageName = "";
        if (file instanceof JavaFileNode) {
            if (((JavaFileNode)file).getParent() instanceof PackageNode) {
                packageName = ((PackageNode)((JavaFileNode)file).getParent()).getPackage();
            }
            if (!packageName.isEmpty()) {
                packageName = packageName + ".";
            }
            return packageName + file.getName().substring(0, file.getName().lastIndexOf('.'));
        } else if (file instanceof JarFileNode) {
            return file.getPath();
        }
        return file.getName().substring(0, file.getName().lastIndexOf('.'));
    }

    private static String removeEndingPathSeparator(String path) {
        if (path.endsWith("/")) {
            return path.substring(0, path.length() - 1);
        }

        return path;
    }

    private static String addStartingPathSeparator(String path) {
        if (!path.startsWith("/")) {
            return "/" + path;
        }

        return path;
    }

    @Nullable
    public static String getProjectBuilder(HasProjectConfig node) {
        return getProjectBuilder(node.getProjectConfig().getType());
    }

    @Nullable
    public static String getProjectBuilder(@Nullable String projectType) {
        if (projectType == null) {
            return null;
        }

        switch (projectType) {
            case "maven":
            case "ant":
                return projectType;
            default:
                return null;
        }
    }
}