org.mdiutil.lang

Class ExecutableFinder

java.lang.Object

org.mdiutil.lang.ExecutableFinder

public class ExecutableFinder
extends Object

This class allows to get a list of executables from a list of roots. Note that in all case only executables which are valid for the System architecture will be added to the list:

• On Windows: Portable Executables
• On Unix and Linux: ELF Executables
• On Mach OS X: Mach-O Executables

Also on a 32 bit platform, 64 bits executables will not be added to the list.

Usage

• Add the list of roots which will be used to look for the executables
• Get the list of executables, defining a directory path pattern and a file path pattern. The directory pattern defines the directories which will be searched for under the roots. The file pattern defines the file which will be searched for under these directories

The two patterns can use wildcards and simple regular expressions. For example:

• getExecutables("netbeans*", "bin/netbeans*.exe will look for directories whose name begins with "netbeans" (for example netbeans 8.2 would be a valid name), and files whose name begins with "netbeans" and with an ".exe" extension under these directories.

Examples of usage

Look for the Netbeans executable on the Windows Program Files directory

Suppose that we want to get the Netbeans executables on Windows. If we are on 64 bits, we can do:

 ExecutableFinder finder = new ExecutableFinder(false);
 finder.addRootFromEnv("programfiles");
 List<File> files = finder.getExecutables("netbeans*", "bin/*.exe");
 

If we have only one Netbeans installation, the method will return two files:

• The Netbeans.exe executable
• The Netbeans64.exe executable

Now if we are on 32 bits, we will have only one file in the list:

• The Netbeans.exe executable

And if we are on 64 bits, but we set the finder to be strict, we will also have only one file in the list:

• The Netbeans64.exe executable

Look for the Python executable

We will look for the python executable anywhere on a top-level directory.

 ExecutableFinder finder = new ExecutableFinder(true);
 finder.addAllRoots();
 List<File> files = finder.getExecutables("python*", "*.exe");
 

Field Summary

Fields

Modifier and Type	Field and Description
static short	MODE_ALL Represents the mode where a root maybe either the parent of a directory containing the executable, or this directory itself.
static short	MODE_PATTERN Represents the mode where a root may only be a directory containing the executable.
static short	MODE_ROOT Represents the mode where a root may only be the parent of a directory containing the executable.

Constructor Summary

Constructors

Constructor and Description
ExecutableFinder(boolean isStrict) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAllRoots() Add all the file system root directories for the finder.
boolean	addRoot(File root) Add a root directory for the finder.
boolean	addRootFromEnv(String env) Add a root directory or several root directories from an environment variable, with the MODE_ALL mode.
boolean	addRootFromEnv(String env, short mode) Add a root directory or several root directories from an environment variable.
List<File>	getExecutables(String dirPattern, String filePattern) Return a list of executables from a directory Pattern and file pattern.
boolean	isCaseInsensitive() Return true if the finder is case insensitive.
void	setCaseInsensitive(boolean caseInsensitive) Set the finder as case insensitive.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_ALL

public static final short MODE_ALL

Represents the mode where a root maybe either the parent of a directory containing the executable, or this directory itself.

See Also:

Constant Field Values

MODE_ROOT

public static final short MODE_ROOT

Represents the mode where a root may only be the parent of a directory containing the executable.

See Also:

Constant Field Values

MODE_PATTERN

public static final short MODE_PATTERN

Represents the mode where a root may only be a directory containing the executable.

See Also:

Constant Field Values

Constructor Detail

ExecutableFinder

public ExecutableFinder(boolean isStrict)

Constructor.

Parameters:

isStrict - true if the finder must find only executables which are defined for the JVM architecture

Method Detail

addRoot

public boolean addRoot(File root)

Add a root directory for the finder.

Parameters:

root - the root directory

Returns:

true if the root directory exists and is a directory

addAllRoots

public void addAllRoots()

Add all the file system root directories for the finder.

setCaseInsensitive

public void setCaseInsensitive(boolean caseInsensitive)

Set the finder as case insensitive. Note that by default, the finder is case sensitive, except on Windows where the finder will be case insensitive regardless of the value of this property.

Parameters:

caseInsensitive - true if the finder must be caseInsensitive

isCaseInsensitive

public boolean isCaseInsensitive()

Return true if the finder is case insensitive.

Returns:

true if the finder is case insensitive

addRootFromEnv

public boolean addRootFromEnv(String env)

Add a root directory or several root directories from an environment variable, with the MODE_ALL mode.

Parameters:

env - the environment variable

Returns:

true if the environment variable exists, and the one or several associated root directories exist

addRootFromEnv

public boolean addRootFromEnv(String env,
                              short mode)

Add a root directory or several root directories from an environment variable. The possible modes are:

• MODE_ALL: Represents the mode where a root maybe either the parent of a directory contining the executable, or this directory itself
• MODE_ROOT: Represents the mode where a root may only be the parent of a directory containing the executable
• MODE_PATTERN: Represents the mode where a root may only be a directory containing the executable

Parameters:

env - the environment variable

mode - the mode

Returns:

true if the environment variable exists, and the one or several associated root directories exist

getExecutables

public List<File> getExecutables(String dirPattern,
                                 String filePattern)

Return a list of executables from a directory Pattern and file pattern. The two patterns can use wildcards and simple regular expressions. For example:

• getExecutables("netbeans*", "bin/netbeans*.exe will look for directories whose name begins with "netbeans" (for example netbeans 8.2 would be a valid name), and files whose name begins with "netbeans" and with an ".exe" extension under these directories.

Parameters:

dirPattern - the directory Pattern

filePattern - the file pattern

Returns:

the list of executables