com.devonfw.cobigen.api.util.CobiGenPathUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation
A Code-based incremental Generator
There is a newer version: 2021.12.006
package com.devonfw.cobigen.api.util;

import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import com.devonfw.cobigen.api.constants.ConfigurationConstants;

/**
 * Utilities for handling CobiGen home directory
 */
public class CobiGenPathUtil {

    /**
     * Returns the CobiGen home directory, or creates a new one if it does not exist
     * @return {@link Path} of the CobiGen home directory
     */
    public static Path getCobiGenFolderPath() {

        String path = getUsersHomeDir() + File.separator + ConfigurationConstants.COBIGEN_HOME_FOLDER;
        Path cobiGenPath = Paths.get(path);

        // We first check whether we already have a directory
        if (Files.exists(cobiGenPath)) {
            return cobiGenPath;
        }

        if (new File(path).mkdir()) {
            return cobiGenPath;
        } else {
            // Folder has not been created
            return null;
        }

    }

    /**
     * Returns the templates home directory (which is located inside CobiGen home folder), or creates a new
     * one if it does not exist
     * @return {@link Path} of the templates home directory
     */
    public static Path getTemplatesFolderPath() {

        Path templatesPath = getCobiGenFolderPath().resolve(ConfigurationConstants.TEMPLATES_FOLDER);

        // We first check whether we already have a directory
        if (Files.exists(templatesPath)) {
            return templatesPath;
        }

        if (templatesPath.toFile().mkdir()) {
            return templatesPath;
        } else {
            // Folder has not been created
            return null;
        }
    }

    /**
     * Returns the directory where the external processes are located, or creates a new one if it was not
     * present
     * @param processPath
     *            name of the process
     * @return {@link Path} of the external processes home directory
     */
    public static Path getExternalProcessesPath(String processPath) {

        Path home = getCobiGenFolderPath();

        // We first check whether we already have a directory
        if (Files.exists(home.resolve(processPath))) {
            return home.resolve(processPath);
        }

        if (new File(home.resolve(processPath).toUri()).mkdir()) {
            return home.resolve(processPath);
        } else {
            // Folder has not been created
            return null;
        }

    }

    /**
     * Returns the current users home directory OS independent
     * @return string path of current users home directory
     */
    private static String getUsersHomeDir() {
        String users_home = System.getProperty("user.home");
        return users_home.replace("\\", "/"); // to support all platforms.
    }

}