com.starteam.util
Class OSEnvironment

java.lang.Object
  com.starteam.util.OSEnvironment

public final class OSEnvironment
extends java.lang.Object

Support for reading environment variables from the Operating System.

Method Summary

static java.lang.String	getEnvironmentVariable(java.lang.String varName) Returns a value of the specified environment variable.
static boolean	isAvailable() Determines if the needed support for environment variables is working.

Methods inherited from class java.lang.Object

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

Method Detail

isAvailable

public static boolean isAvailable()

Determines if the needed support for environment variables is working.

Returns:

true if calls to getEnvironmentVariable will be valid.

See Also:

OSEnvironment.getEnvironmentVariable(java.lang.String)

getEnvironmentVariable

public static java.lang.String getEnvironmentVariable(java.lang.String varName)
                                               throws java.io.IOException

Returns a value of the specified environment variable. Calls to this method are only valid if isAvailable returns true.

Parameters:

varName - name of the environment variable to lookup.

Returns:

the value of the variable if set, null otherwise.

Throws:

java.io.IOException

See Also:

OSEnvironment.isAvailable()