org.eclipse.jdt.internal.launching

Class ClasspathShortener

java.lang.Object

org.eclipse.jdt.internal.launching.ClasspathShortener

public class ClasspathShortener
extends java.lang.Object

Shorten the classpath/modulepath if necessary. Depending on the java version, os and launch configuration, the classpath argument will be replaced by an argument file, a classpath-only jar or env variable. The modulepath is replaced by an argument file if necessary.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARG_MAX_LINUX
static int	ARG_MAX_MACOS
static int	ARG_MAX_WINDOWS
static int	MAX_ARG_STRLEN_LINUX

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClasspathShortener(IVMInstall vmInstall, ILaunch launch, java.lang.String[] cmdLine, int lastJavaArgumentIndex, java.io.File workingDir, java.lang.String[] envp)
protected	ClasspathShortener(java.lang.String os, java.lang.String javaVersion, ILaunch launch, java.lang.String[] cmdLine, int lastJavaArgumentIndex, java.io.File workingDir, java.lang.String[] envp)

Method Summary

Modifier and Type	Method and Description
protected void	addProcessTempFile(java.io.File file)
java.lang.String[]	getCmdLine() Get the new command line.
java.lang.String[]	getEnvp() Get the new envp.
static java.lang.String	getJavaVersion(IVMInstall vmInstall)
protected java.lang.String	getLaunchConfigurationName()
protected boolean	getLaunchConfigurationUseClasspathOnlyJarAttribute()
protected java.lang.String	getLaunchTimeStamp()
protected int	getMaxArgLength()
protected int	getMaxCommandLineLength()
protected java.util.Map<java.lang.String,java.lang.String>	getNativeEnvironment()
protected char	getPathSeparatorChar()
java.util.List<java.io.File>	getProcessTempFiles() Necessary files that were created for starting the process.
java.io.File	getProcessTempFilesDir()
protected boolean	handleClasspathTooLongStatus()
java.lang.String	quoteWindowsPath(java.lang.String path)
void	setProcessTempFilesDir(java.io.File processTempFilesDir) The directory to use to create temp files needed when shortening the classpath.
boolean	shortenCommandLineIfNecessary() Shorten the command line if necessary.

Methods inherited from class java.lang.Object

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

Field Detail

ARG_MAX_LINUX

public static final int ARG_MAX_LINUX

See Also:

Constant Field Values

ARG_MAX_WINDOWS

public static final int ARG_MAX_WINDOWS

See Also:

Constant Field Values

ARG_MAX_MACOS

public static final int ARG_MAX_MACOS

See Also:

Constant Field Values

MAX_ARG_STRLEN_LINUX

public static final int MAX_ARG_STRLEN_LINUX

See Also:

Constant Field Values

Constructor Detail

ClasspathShortener

public ClasspathShortener(IVMInstall vmInstall,
                          ILaunch launch,
                          java.lang.String[] cmdLine,
                          int lastJavaArgumentIndex,
                          java.io.File workingDir,
                          java.lang.String[] envp)

Parameters:

vmInstall - the vm installation

launch - the launch

cmdLine - the command line (java executable + VM arguments + program arguments)

lastJavaArgumentIndex - the index of the last java argument in cmdLine (next arguments if any are program arguments)

workingDir - the working dir to use for the launched VM or null

envp - array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.

ClasspathShortener

protected ClasspathShortener(java.lang.String os,
                             java.lang.String javaVersion,
                             ILaunch launch,
                             java.lang.String[] cmdLine,
                             int lastJavaArgumentIndex,
                             java.io.File workingDir,
                             java.lang.String[] envp)

Method Detail

setProcessTempFilesDir

public void setProcessTempFilesDir(java.io.File processTempFilesDir)

The directory to use to create temp files needed when shortening the classpath. By default, the working directory is used The java.io.tmpdir should not be used on MacOs (does not work for classpath-only jars)

Parameters:

processTempFilesDir -

getProcessTempFilesDir

public java.io.File getProcessTempFilesDir()

getEnvp

public java.lang.String[] getEnvp()

Get the new envp. May have been modified to shorten the classpath

Returns:

environment variables in the format name=value or null

getCmdLine

public java.lang.String[] getCmdLine()

Get the new command line. Modified if command line or classpath argument were too long

Returns:

the command line (java executable + VM arguments + program arguments)

getProcessTempFiles

public java.util.List<java.io.File> getProcessTempFiles()

Necessary files that were created for starting the process. They can be deleted once the process is terminated

Returns:

created files

shortenCommandLineIfNecessary

public boolean shortenCommandLineIfNecessary()

Shorten the command line if necessary. Each OS has different limits for command line length or command line argument length. And depending on the OS, JVM version and launch configuration, we shorten the classpath using an argument file, a classpath-only jar or env variable. If we need to use a classpath-only jar to shorten the classpath, we ask confirmation from the user because it can have side effects (System.getProperty("java.class.path") will return a classpath with only one jar). If IJavaLaunchConfigurationConstants.ATTR_USE_CLASSPATH_ONLY_JAR is set, a classpath-only jar is used (without asking confirmation).

Returns:

true if command line has been shortened or false if it was not necessary or not possible. Use getCmdLine() and getEnvp() to get the new command line/environment.

getLaunchConfigurationUseClasspathOnlyJarAttribute

protected boolean getLaunchConfigurationUseClasspathOnlyJarAttribute()
                                                              throws CoreException

Throws:

CoreException

getJavaVersion

public static java.lang.String getJavaVersion(IVMInstall vmInstall)

getMaxCommandLineLength

protected int getMaxCommandLineLength()

getMaxArgLength

protected int getMaxArgLength()

addProcessTempFile

protected void addProcessTempFile(java.io.File file)

handleClasspathTooLongStatus

protected boolean handleClasspathTooLongStatus()
                                        throws CoreException

Throws:

CoreException

getPathSeparatorChar

protected char getPathSeparatorChar()

getLaunchConfigurationName

protected java.lang.String getLaunchConfigurationName()

getLaunchTimeStamp

protected java.lang.String getLaunchTimeStamp()

getNativeEnvironment

protected java.util.Map<java.lang.String,java.lang.String> getNativeEnvironment()

quoteWindowsPath

public java.lang.String quoteWindowsPath(java.lang.String path)