org.jsweet.transpiler.util

Class ProcessUtil

java.lang.Object

org.jsweet.transpiler.util.ProcessUtil

public class ProcessUtil
extends Object

A set of utilities to launch external processes from Java.

Author:

Renaud Pawlak

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_COMMAND The node command name (can be full path in some environments).
static String	NODE_MINIMUM_VERSION
static String	NPM_COMMAND The npm command name (can be full path in some environments).
static File	NPM_DIR A static field that stores the JSweet npm directory.
static File	USER_HOME_DIR A static field that stores the user home directory.

Constructor Summary

Constructors

Constructor and Description
ProcessUtil()

Method Summary

Modifier and Type	Method and Description
static void	addExtraPath(String extraPath)
static String	findGlobalExecutable(String fileName, String packageName)
static String	getGlobalNpmPackageExecutablePath(String command) Gets the full path of a global package's JS main file installed with npm.
static String	getGlobalNpmPackageNodeMainFilePath(String nodeModule, String mainFileName) Gets the full path of a global package's (system) command installed with npm.
static String	getGlobalNpmPackagePath(String packageName) Gets the full path of a global package installed with npm.
static void	initNode() Initializes the node command paths (OS-specific initializations).
static void	installNodePackage(String nodePackageName, String version, boolean global) Installs a node package with npm (assumes that node is installed).
static boolean	isInstalledWithNpm(String command) Tells if this node command is installed.
static boolean	isNodePackageInstalled(String nodePackageName) Checks if a node package has been installed locally.
static boolean	isVersionHighEnough(String currentVersion, String minimumVersion)
static boolean	isWindows()
static Process	runAsyncCommand(String command, Consumer<String> stdoutConsumer, Consumer<Process> endConsumer, Runnable errorHandler, String... args) Runs the given command in an asynchronous manner.
static Process	runCommand(String command, Consumer<String> stdoutConsumer, Runnable errorHandler, String... args) Runs the given command.
static Process	runCommand(String command, File directory, boolean async, Consumer<String> stdoutConsumer, Consumer<Process> endConsumer, Runnable errorHandler, String... args) Runs the given command.
static void	uninstallNodePackage(String nodePackageName, boolean global) Uninstalls a node package with npm (assumes that node is installed).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODE_MINIMUM_VERSION

public static final String NODE_MINIMUM_VERSION

See Also:

Constant Field Values

USER_HOME_DIR

public static File USER_HOME_DIR

A static field that stores the user home directory.

NPM_DIR

public static File NPM_DIR

A static field that stores the JSweet npm directory.

NODE_COMMAND

public static String NODE_COMMAND

The node command name (can be full path in some environments).

NPM_COMMAND

public static String NPM_COMMAND

The npm command name (can be full path in some environments).

Constructor Detail

ProcessUtil

public ProcessUtil()

Method Detail

initNode

public static void initNode()

Initializes the node command paths (OS-specific initializations).

addExtraPath

public static void addExtraPath(String extraPath)

getGlobalNpmPackageNodeMainFilePath

public static String getGlobalNpmPackageNodeMainFilePath(String nodeModule,
                                                         String mainFileName)

Gets the full path of a global package's (system) command installed with npm.

getGlobalNpmPackageExecutablePath

public static String getGlobalNpmPackageExecutablePath(String command)

Gets the full path of a global package's JS main file installed with npm.

getGlobalNpmPackagePath

public static String getGlobalNpmPackagePath(String packageName)

Gets the full path of a global package installed with npm.

isInstalledWithNpm

public static boolean isInstalledWithNpm(String command)

Tells if this node command is installed.

runCommand

public static Process runCommand(String command,
                                 Consumer<String> stdoutConsumer,
                                 Runnable errorHandler,
                                 String... args)

Runs the given command.

Parameters:

command - the command name

stdoutConsumer - consumes the standard output stream as lines of characters

errorHandler - upcalled when the command does not terminate successfully

args - the command-line arguments

Returns:

the process that was created to execute the command (exited at this point)

runAsyncCommand

public static Process runAsyncCommand(String command,
                                      Consumer<String> stdoutConsumer,
                                      Consumer<Process> endConsumer,
                                      Runnable errorHandler,
                                      String... args)

Runs the given command in an asynchronous manner.

Parameters:

command - the command name

stdoutConsumer - consumes the standard output stream as lines of characters

endConsumer - called when the process actually ends

errorHandler - upcalled when the command does not terminate successfully

args - the command-line arguments

Returns:

the process that was created to execute the command (can be still running at this point)

runCommand

public static Process runCommand(String command,
                                 File directory,
                                 boolean async,
                                 Consumer<String> stdoutConsumer,
                                 Consumer<Process> endConsumer,
                                 Runnable errorHandler,
                                 String... args)

Runs the given command.

Parameters:

command - the command name

directory - the working directory of the created process

async - tells if the command should be run asynchronously (in a separate thread)

stdoutConsumer - consumes the standard output stream as lines of characters

endConsumer - called when the process actually ends

errorHandler - upcalled when the command does not terminate successfully

args - the command-line arguments

Returns:

the process that was created to execute the command (can be still running at this point if async is true)

isWindows

public static boolean isWindows()

installNodePackage

public static void installNodePackage(String nodePackageName,
                                      String version,
                                      boolean global)

Installs a node package with npm (assumes that node is installed).

Parameters:

nodePackageName - the package name

global - true for adding the -g option

isNodePackageInstalled

public static boolean isNodePackageInstalled(String nodePackageName)

Checks if a node package has been installed locally.

Parameters:

nodePackageName - the node module to be tested

Returns:

true if already installed locally

uninstallNodePackage

public static void uninstallNodePackage(String nodePackageName,
                                        boolean global)

Uninstalls a node package with npm (assumes that node is installed).

Parameters:

nodePackageName - the package name

global - true for adding the -g option

isVersionHighEnough

public static boolean isVersionHighEnough(String currentVersion,
                                          String minimumVersion)

findGlobalExecutable

public static String findGlobalExecutable(String fileName,
                                          String packageName)