org.refcodes.runtime.utils

Class SystemUtility

java.lang.Object

org.refcodes.runtime.utils.SystemUtility

public final class SystemUtility
extends Object

Utility for acquiring system information on the machine this process is running in.

Method Summary

Modifier and Type	Method and Description
static String	exec(String aCommand) Executes a command and returns the output.
static CommandLineInterpreter	getCommandLineInterpreter() Tries to determine the command line interpreter (CLI) - if any - this process is running in, e.g. whether we are running in a DOS console environment or a Linux alike Shell.
static String	getComputerName() Determines the computer's name.
static int	getConsoleHeight() Determines the height in characters of the system's console in use.
static int	getConsoleWidth() Determines the width in characters of the system's console in use.
static String	getLineBreak() Determines the operating system as of getOperatingSystem() and in case a OperatingSystem.WINDOWS is being detected, then \r\n" (CRLF) is returned, else "\n" (LF) is returned.
static OperatingSystem	getOperatingSystem() Determines the operating system your application is currently running on.
static String	getSystemEncoding() Determines the encoding of the system (system's console) in use as of System.out.
static File	getTempDir() Returns the operating saystem's temp folder.
static String	getUname() If on a *nix alike system, this method returns the output of the "uname -a" command: "uname" prints system information, "-a" instructs it to print all information.
static boolean	isAnsiSupported() Determines whether ANSI escape sequences are supported by the console.

Methods inherited from class java.lang.Object

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

Method Detail

getOperatingSystem

public static OperatingSystem getOperatingSystem()

Determines the operating system your application is currently running on.

Returns:

The OperatingSystem being detected.

getLineBreak

public static String getLineBreak()

Determines the operating system as of getOperatingSystem() and in case a OperatingSystem.WINDOWS is being detected, then \r\n" (CRLF) is returned, else "\n" (LF) is returned.

Returns:

The operating specific line break; on Windows it is "\r\n" (CRLF) and on all other operating systems it is "\n" (LF).

getComputerName

public static String getComputerName()

Determines the computer's name. First it tries to get it from the InetAddress, if it fails it tries to get it from the system's environment using the SystemConsts.ENV_VAR_WIN_COMPUTERNAME (on Windows machines only) and if both fails, it returns the default QueryConsts.NAME_LOCALHOST identifier.

Returns:

The computer's name, as fallback, SystemConsts.NAME_LOCALHOST ("localhost") is returned.

getUname

public static String getUname()

If on a *nix alike system, this method returns the output of the "uname -a" command: "uname" prints system information, "-a" instructs it to print all information.

Returns:

The "uname -a" output or null if "uname" is not known.

getCommandLineInterpreter

public static CommandLineInterpreter getCommandLineInterpreter()

Tries to determine the command line interpreter (CLI) - if any - this process is running in, e.g. whether we are running in a DOS console environment or a Linux alike Shell.

Returns:

The CLI type, in case we are in a DOS / WIN_CMD console environment, CommandLineInterpreter.WIN_CMD is returned (for example).

getConsoleWidth

public static int getConsoleWidth()

Determines the width in characters of the system's console in use. In case you pass a "-Dconsole.width=n" (where n stands for the number of chars per row) JVM argument, then your width is taken, else the actual console's width is being tried to be determined. In case this fails -1 is returned. In such a case you might use RuntimeConsts.MAX_CONSOLE_WIDTH, RuntimeConsts.NORM_CONSOLE_WIDTH or RuntimeConsts.MIN_CONSOLE_WIDTH

Returns:

The width of the console in characters or -1 if the width cannot be determined.

getConsoleHeight

public static int getConsoleHeight()

Determines the height in characters of the system's console in use. In case you pass a "-Dconsole.height=n" (where n stands for the number of lines) JVM argument, then your height is taken, else the actual console's height is being tried to be determined. In case this fails -1 is returned. In such a case you might use RuntimeConsts.MAX_CONSOLE_HEIGHT, RuntimeConsts.NORM_CONSOLE_HEIGHT or RuntimeConsts.MIN_CONSOLE_HEIGHT

Returns:

The height of the console in characters or -1 if the height cannot be determined.

exec

public static String exec(String aCommand)

Executes a command and returns the output.

Returns:

Null if execution failed, else the according output. An empty String stands fur successful execution.

isAnsiSupported

public static boolean isAnsiSupported()

Determines whether ANSI escape sequences are supported by the console.

Returns:

True in case ANSI escape sequences are supported, else false.

getTempDir

public static File getTempDir()

Returns the operating saystem's temp folder.

Returns:

The folder used by the OS for storing temporary files.

getSystemEncoding

public static String getSystemEncoding()

Determines the encoding of the system (system's console) in use as of System.out.

Returns:

The encoding (of the console).