org.safs.android.auto.lib

Class ConsoleTool

java.lang.Object

org.safs.android.auto.lib.ConsoleTool

Direct Known Subclasses:

AndroidTools, AntTool, DefaultConsoleTool

public abstract class ConsoleTool
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	binDirectories contains possible absolute path directory. contains possible sub-directories from tool-home where the tool stays For example, bin, tools, platform-tools etc.
protected Console	console

Constructor Summary

Constructors

Constructor and Description
ConsoleTool()

Method Summary

Modifier and Type	Method and Description
Process2	batch(java.io.File workingDirectory, java.util.List<java.lang.String> batchAndArgs)
Process2	batch(java.io.File workingDirectory, java.lang.String... batchAndArgs)
Process2	batch(java.lang.String tool, java.lang.String... args) Execute a batch file.
Process2	exec(java.io.File workingDirectory, java.util.List<java.lang.String> binaryAndArgs)
Process2	exec(java.io.File workingDirectory, java.lang.String... binaryAndArgs)
Process2	exec(java.lang.String tool, java.util.List<java.lang.String> args)
Process2	exec(java.lang.String tool, java.lang.String... args) Execute an executable.
java.util.List<java.lang.String>	getBinDirectories()
java.lang.String	getLastCommand()
static java.lang.String	getOsFamilyName()
java.lang.String	getToolHome() This method will firstly try to return the field toolHome If it is null, it will try to get the toolHome from properties getToolHomeProperties() If still not found, it will try to get the toolHome from environments getToolHomeEnvs() If still not found, it will throw out IllegalStateException. If the toolHome if found, it will be set to field toolHome.
protected java.util.List<java.lang.String>	getToolHomeEnvs() Subclass should override this method to provide its own environment variables.
protected java.util.List<java.lang.String>	getToolHomeProperties() Subclass should override this method to provide its own system properties.
static boolean	isMacOS()
static boolean	isUnixOS()
static boolean	isWindowsOS()
protected java.lang.String	locateTool(java.lang.String tool) Try to find the location of the executable tools in the sdk's home path.
protected abstract void	modifyBinDirectories() This method will modify the binDirectories according to tool itself.
protected boolean	needSearchRecursively(java.lang.String directoryName)
protected java.lang.String	searchFile(java.io.File directory, java.lang.String filename, boolean recusive) Try to find a file matching 'filename' within directory.
void	setToolHome(java.lang.String toolHome) Only you are sure about the tool's home, you can set it. Because if you set it, getToolHome() will not try to get the tool's home from "JVM properties" or "System environment variables" This method will verify if the toolHome exists and is a directory.

Methods inherited from class java.lang.Object

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

Field Detail

console

protected Console console

binDirectories

protected final java.util.List<java.lang.String> binDirectories

contains possible absolute path directory.
contains possible sub-directories from tool-home where the tool stays
For example, bin, tools, platform-tools etc.

Constructor Detail

ConsoleTool

public ConsoleTool()

Method Detail

getBinDirectories

public java.util.List<java.lang.String> getBinDirectories()

modifyBinDirectories

protected abstract void modifyBinDirectories()

This method will modify the binDirectories according to tool itself.

See Also:

binDirectories

getOsFamilyName

public static java.lang.String getOsFamilyName()

isWindowsOS

public static boolean isWindowsOS()

isUnixOS

public static boolean isUnixOS()

isMacOS

public static boolean isMacOS()

locateTool

protected java.lang.String locateTool(java.lang.String tool)

Try to find the location of the executable tools in the sdk's home path. It will try to look the tool in some sub directories, such as bin, tools If still not found, throw the IllegalStateException.

Parameters:

tool - name like "adb.exe", "batch.bat" or "script.sh" etc...

Returns:

String absolute path to the tool or throws the exception

Throws:

java.lang.IllegalStateException - if tool cannot be found.

searchFile

protected java.lang.String searchFile(java.io.File directory,
                                      java.lang.String filename,
                                      boolean recusive)

Try to find a file matching 'filename' within directory.

Parameters:

directory - File, the directory in which to search file

filename - String, the filename to match

recusive - boolean, if we need to search files in sub-directories

Returns:

String, the absolute filename or null if not found.

See Also:

locateTool(String)

needSearchRecursively

protected boolean needSearchRecursively(java.lang.String directoryName)

Parameters:

directoryName - String, the directory to be searched

Returns:

boolean, true if we need to search in the sub-directories

See Also:

locateTool(String)

setToolHome

public void setToolHome(java.lang.String toolHome)

Only you are sure about the tool's home, you can set it.
Because if you set it, getToolHome() will not try to get the tool's home
from "JVM properties" or "System environment variables"
This method will verify if the toolHome exists and is a directory. If not, it will
throw out IllegalStateException.

Parameters:

toolHome -

Throws:

java.lang.IllegalStateException

See Also:

getToolHome()

getToolHome

public java.lang.String getToolHome()

This method will firstly try to return the field toolHome
If it is null, it will try to get the toolHome from properties getToolHomeProperties()
If still not found, it will try to get the toolHome from environments getToolHomeEnvs()
If still not found, it will throw out IllegalStateException.
If the toolHome if found, it will be set to field toolHome.

Returns:

The tool home where (or sub-directory) the tools' executable can be found.

Throws:

java.lang.IllegalStateException

See Also:

setToolHome(String)

getToolHomeProperties

protected java.util.List<java.lang.String> getToolHomeProperties()

Subclass should override this method to provide its own system properties.

Returns:

A list of 'system property name', where the 'tool home' may be stored.

getToolHomeEnvs

protected java.util.List<java.lang.String> getToolHomeEnvs()

Subclass should override this method to provide its own environment variables.

Returns:

A list of 'environment variable name', where the 'tool home' may be stored.

getLastCommand

public java.lang.String getLastCommand()

exec

public Process2 exec(java.lang.String tool,
                     java.lang.String... args)
              throws java.io.IOException

Execute an executable. For .bat batch, please call batch() command instead.

Parameters:

tool, - String, the executable (.exe)

args, - String, the parameters of the executable.

Returns:

Throws:

java.io.IOException

exec

public Process2 exec(java.lang.String tool,
                     java.util.List<java.lang.String> args)
              throws java.io.IOException

Throws:

java.io.IOException

exec

public Process2 exec(java.io.File workingDirectory,
                     java.lang.String... binaryAndArgs)
              throws java.io.IOException

Throws:

java.io.IOException

exec

public Process2 exec(java.io.File workingDirectory,
                     java.util.List<java.lang.String> binaryAndArgs)
              throws java.io.IOException

Throws:

java.io.IOException

batch

public Process2 batch(java.lang.String tool,
                      java.lang.String... args)
               throws java.io.IOException

Execute a batch file. For .exe executable, please call exec() command instead.

Parameters:

tool, - String, the batch file (.bat)

args, - String, the parameters for the batch file

Returns:

Throws:

java.io.IOException

batch

public Process2 batch(java.io.File workingDirectory,
                      java.lang.String... batchAndArgs)
               throws java.io.IOException

Throws:

java.io.IOException

batch

public Process2 batch(java.io.File workingDirectory,
                      java.util.List<java.lang.String> batchAndArgs)
               throws java.io.IOException

Throws:

java.io.IOException