|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compomics.software.CompomicsWrapper
public class CompomicsWrapper
A general wrapper for compomics tools. All tools shall contain a resources/conf folder. In it a JavaOptions.txt and splash screen. Eventually JavaHome.txt and proxy/uniprotjapi.properties.
Constructor Summary | |
---|---|
CompomicsWrapper()
Constructor. |
Method Summary | |
---|---|
static void |
checkForNewVersion(String currentVersion,
String toolName,
String googleCodeToolName)
Check if a newer version of the tool is available on GoogleCode, and closes the tool if the user decided to upgrade. |
static void |
checkForNewVersion(String currentVersion,
String toolName,
String googleCodeToolName,
boolean closeToolWhenUpgrading,
String zipFileTag,
String zipFileType)
Check if a newer version of the tool is available on GoogleCode. |
static void |
checkJavaVersion(String toolName)
Checks if the user is running Java 64 bit and shows a warning if not. |
static String |
getJarFilePath(String classPath,
String toolName)
Returns the path to the jar file. |
ArrayList<String> |
getJavaHomeAndOptions(String toolPath)
Returns an array list containing the Java home plus any parameters to the JVM. |
void |
launchTool(String toolName,
File jarFile,
String splashName,
String mainClass)
Starts the launcher by calling the launch method. |
void |
launchTool(String toolName,
File jarFile,
String splashName,
String mainClass,
String[] args)
Starts the launcher by calling the launch method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CompomicsWrapper()
Method Detail |
---|
public void launchTool(String toolName, File jarFile, String splashName, String mainClass)
toolName
- jarFile
- the jar file to executesplashName
- the splash name, for example peptide-shaker-splash.pngmainClass
- the main class to execute, for example
eu.isas.peptideshaker.gui.PeptideShakerGUIpublic void launchTool(String toolName, File jarFile, String splashName, String mainClass, String[] args)
toolName
- jarFile
- the jar file to executesplashName
- the splash name, for example peptide-shaker-splash.png,
can be nullmainClass
- the main class to execute, for example
eu.isas.peptideshaker.gui.PeptideShakerGUIargs
- the arguments to pass to the tool (ignored if null)public static String getJarFilePath(String classPath, String toolName)
classPath
- the class path to extract the jar file path fromtoolName
- the name of the tool, e.g., "PeptideShaker" or
"SearchGUI".
public static void checkJavaVersion(String toolName)
toolName
- the name of the tool, e.g., "PeptideShaker"public static void checkForNewVersion(String currentVersion, String toolName, String googleCodeToolName)
currentVersion
- the version number of the tool currently runningtoolName
- the name of the tool, e.g., "PeptideShaker"googleCodeToolName
- the GoogleCode name of the tool, e.g.,
"peptide-shaker"public static void checkForNewVersion(String currentVersion, String toolName, String googleCodeToolName, boolean closeToolWhenUpgrading, String zipFileTag, String zipFileType)
currentVersion
- the version number of the tool currently runningtoolName
- the name of the tool, e.g., "PeptideShaker"googleCodeToolName
- the GoogleCode name of the tool, e.g.,
"peptide-shaker"closeToolWhenUpgrading
- if true, the tool will close when the
download page is opened, false only opens the download pagezipFileTag
- the zip file tag, e.g., SearchGUI-1.10.4_windows.zip
has the tag "_windows"zipFileType
- the zip file type, e.g., ".zip" or ".tar.gz"public ArrayList<String> getJavaHomeAndOptions(String toolPath) throws FileNotFoundException, IOException, ClassNotFoundException
toolPath
- the path to the jar file of the tool
FileNotFoundException
IOException
ClassNotFoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |