SysUtil (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.util.SysUtil

```
public class SysUtil
extends java.lang.Object
```
Provides generally useful methods for system inquiries and other system related functionality.
For example it is strongly recommended to uset exit(int) rather than System.exit(int) to terminate a JVM. It allows registered listeners to be notified just before the exit happens.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`AIX`
`static boolean`	`DEBUG`
`protected static java.lang.String`	`DIGITAL_UNIX`
`protected static java.lang.String`	`FREE_BSD`
`protected static java.lang.String`	`HP_UX`
`protected static java.lang.String`	`IRIX`
`static java.lang.String`	`JAVA_HOME_DIR` Contains the value of system property "java.home" as set at startup.
`protected static java.lang.String`	`LINUX`
`static java.lang.String`	`OS_FAMILY_MACINTOSH` "macintosh"
`static java.lang.String`	`OS_FAMILY_UNIX` "unix"
`static java.lang.String`	`OS_FAMILY_UNKNOWN` "unknown"
`static java.lang.String`	`OS_FAMILY_WINDOWS` "windows"
`protected static java.lang.String`	`OS_PROPERTY_NAME`
`protected static java.lang.String`	`OSF1`
`protected static java.lang.String`	`PF_OS_PROPERTY_NAME`
`protected static java.lang.String`	`SOLARIS`
`protected static java.lang.String`	`SUN_OS`
`static SysUtil`	`SYSU` An instance of this class which can be easily included as static import and then used like `SYSU.getOsFamily()`.
`protected static java.lang.String[]`	`UNIX_SYSTEMS`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SysUtil()
Initialize the new instance with default values.

Constructors
Modifier	Constructor and Description
`protected`	`SysUtil()` Initialize the new instance with default values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSystemExitListener(ISystemExitListener listener)` Add the given listener to an internal list so that it would be called right before system exit gets executed via the `exit(int)` method.
`protected static boolean`	`checkIfWindows()`
`boolean`	`close(java.io.Closeable closeable)` Close the given closeable ignoring any exception and checking for null before closing.
`static SysUtil`	`current()` Returns the only instance this class supports (design pattern "Singleton")
`protected boolean`	`determineIfEclipse()` Returns true if the environment is based on eclipse.
`protected static java.lang.String`	`determineOsFamilyName()`
`protected static java.lang.String`	`determineOsFamilyName(java.lang.String operationSystemName)`
`ProcessExecutionResult`	`executeExternal(java.io.File execDir, java.lang.String command, java.lang.String... args)` Executes the specified external command with the given arguments in the specified execution directory and returns the combined result data in an object.
`void`	`exit(int rc)` Calling this method terminates the JVM.
`void`	`exit(int rc, long sleepBeforeExit)` Calling this method terminates the JVM after the specified sleep time.
`java.lang.String`	`getConfigValue(java.lang.String sysPropName, java.lang.String envVarName)` Returns the value of an external configuration setting by checking first a system property and if that is not set an environment variable.
`java.lang.String`	`getConfigValue(java.lang.String sysPropName, java.lang.String envVarName, java.lang.String defaultValue)` Returns the value of an external configuration setting by checking first a system property and if that is not set an environment variable and finally if that's also not set returns the given default value.
`protected java.util.List<ISystemExitListener>`	`getExitListeners()`
`int`	`getJavaRuntimeVersion()` Returns the (normalized) version of the current Java Runtime.
`java.lang.String`	`getJdkBinaryDir()` Returns the path of the currently executing JDK's binary sub directory or null if it is not found (e.g.
`java.lang.String`	`getOsFamily()` Returns the family name of the current operating system according to the name specified in system property "os.name".
`boolean`	`isAppletEnvironment()` Returns true if the code is running as part of an applet in a browser plugin JVM.
`boolean`	`isEclipse()` Returns true if the environment is based on eclipse.
`boolean`	`isExecutingWithJDK()` Returns true if the current Java execution runtime is a JDK and false if it is a JRE.
`boolean`	`isJavaModuleSystemSupportingRuntime()` Returns true if the current JRE used to execute this code is supporting the Java Module System.
`boolean`	`isWindows()` Returns true if the current operating-system is Windows.
`protected void`	`notifyExitListeners(int rc)` Inform all exit listeners that now the system will be exited.
`void`	`removeSystemExitListener(ISystemExitListener listener)` Removes the given listener from the internal list so that it would not be notified anymore before system exit gets executed via the `exit(int)` method.
`protected void`	`reset()`
`protected void`	`setExitListeners(java.util.List<ISystemExitListener> newValue)`
`void`	`sleep(long milliseconds)` Sets the current thread to sleep for the specified time in milliseconds or until it gets interrupted.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSU
```
public static final SysUtil SYSU
```
    An instance of this class which can be easily included as static import and then used like SYSU.getOsFamily().
  - DEBUG
```
public static final boolean DEBUG
```
  - OS_FAMILY_UNKNOWN
```
public static final java.lang.String OS_FAMILY_UNKNOWN
```
    "unknown"
    
    See Also:
    
    Constant Field Values
  - OS_FAMILY_WINDOWS
```
public static final java.lang.String OS_FAMILY_WINDOWS
```
    "windows"
    
    See Also:
    
    Constant Field Values
  - OS_FAMILY_UNIX
```
public static final java.lang.String OS_FAMILY_UNIX
```
    "unix"
    
    See Also:
    
    Constant Field Values
  - OS_FAMILY_MACINTOSH
```
public static final java.lang.String OS_FAMILY_MACINTOSH
```
    "macintosh"
    
    See Also:
    
    Constant Field Values
  - JAVA_HOME_DIR
```
public static final java.lang.String JAVA_HOME_DIR
```
    Contains the value of system property "java.home" as set at startup.
  - OS_PROPERTY_NAME
```
protected static final java.lang.String OS_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - PF_OS_PROPERTY_NAME
```
protected static final java.lang.String PF_OS_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - SOLARIS
```
protected static final java.lang.String SOLARIS
```
    See Also:
    
    Constant Field Values
  - SUN_OS
```
protected static final java.lang.String SUN_OS
```
    See Also:
    
    Constant Field Values
  - LINUX
```
protected static final java.lang.String LINUX
```
    See Also:
    
    Constant Field Values
  - AIX
```
protected static final java.lang.String AIX
```
    See Also:
    
    Constant Field Values
  - HP_UX
```
protected static final java.lang.String HP_UX
```
    See Also:
    
    Constant Field Values
  - FREE_BSD
```
protected static final java.lang.String FREE_BSD
```
    See Also:
    
    Constant Field Values
  - DIGITAL_UNIX
```
protected static final java.lang.String DIGITAL_UNIX
```
    See Also:
    
    Constant Field Values
  - OSF1
```
protected static final java.lang.String OSF1
```
    See Also:
    
    Constant Field Values
  - IRIX
```
protected static final java.lang.String IRIX
```
    See Also:
    
    Constant Field Values
  - UNIX_SYSTEMS
```
protected static final java.lang.String[] UNIX_SYSTEMS
```
- Constructor Detail
  - SysUtil
```
protected SysUtil()
```
    Initialize the new instance with default values.
- Method Detail
  - current
```
public static SysUtil current()
```
    Returns the only instance this class supports (design pattern "Singleton")
  - checkIfWindows
```
protected static boolean checkIfWindows()
```
  - determineOsFamilyName
```
protected static java.lang.String determineOsFamilyName()
```
  - determineOsFamilyName
```
protected static java.lang.String determineOsFamilyName(java.lang.String operationSystemName)
```
  - isWindows
```
public boolean isWindows()
```
    Returns true if the current operating-system is Windows.
  - isEclipse
```
public boolean isEclipse()
```
    Returns true if the environment is based on eclipse. That is, this class is loaded within an eclipse plug-in. Can also be defined by setting system property "org.pf.util.isEclipse" to true or false.
  - isAppletEnvironment
```
public boolean isAppletEnvironment()
```
    Returns true if the code is running as part of an applet in a browser plugin JVM.
  - isExecutingWithJDK
```
public boolean isExecutingWithJDK()
```
    Returns true if the current Java execution runtime is a JDK and false if it is a JRE.
  - getJdkBinaryDir
```
public java.lang.String getJdkBinaryDir()
```
    Returns the path of the currently executing JDK's binary sub directory or null if it is not found (e.g. in case the runtime is a JRE).
  - getOsFamily
```
public java.lang.String getOsFamily()
```
    Returns the family name of the current operating system according to the name specified in system property "os.name".
    
    Returns:
    
    "windows or "unix" or "macintosh" or "unknown" for all others
    
    See Also:
    
    OS_FAMILY_UNKNOWN, OS_FAMILY_UNIX, OS_FAMILY_MACINTOSH, OS_FAMILY_WINDOWS
  - getJavaRuntimeVersion
```
public int getJavaRuntimeVersion()
```
    Returns the (normalized) version of the current Java Runtime. That is for 4 for Java "1.4" or 8 for Java "1.8" and 10 for Java "10".
  - isJavaModuleSystemSupportingRuntime
```
public boolean isJavaModuleSystemSupportingRuntime()
```
    Returns true if the current JRE used to execute this code is supporting the Java Module System. That is, every JRE from version 9 and above.
  - sleep
```
public void sleep(long milliseconds)
```
    Sets the current thread to sleep for the specified time in milliseconds or until it gets interrupted. Avoids throwing an InterruptedException.
    
    Parameters:
    
    milliseconds - The time to sleep
  - exit
```
public void exit(int rc)
```
    Calling this method terminates the JVM.
    It should be used instead of System.exit(int) because it will notify all registered ISystemExitListener before it actually calls System.exit(rc).
    
    Parameters:
    
    rc - The return code to the program that started the JVM.
  - exit
```
public void exit(int rc,
                 long sleepBeforeExit)
```
    Calling this method terminates the JVM after the specified sleep time.
    It should be used instead of System.exit(int) because it will notify all registered ISystemExitListener before it actually calls System.exit(rc).
    This method waits the specified sleep time before it actually exits.
    
    Parameters:
    
    rc - The return code to the program that started the JVM.
    
    sleepBeforeExit - The time to sleep (in milliseconds) before exiting.
  - addSystemExitListener
```
public void addSystemExitListener(ISystemExitListener listener)
```
    Add the given listener to an internal list so that it would be called right before system exit gets executed via the exit(int) method.
    If the listener is already in the internal listener list it will not be added again.
    
    Parameters:
    
    listener - The listener to add. Will be ignored if null.
  - removeSystemExitListener
```
public void removeSystemExitListener(ISystemExitListener listener)
```
    Removes the given listener from the internal list so that it would not be notified anymore before system exit gets executed via the exit(int) method.
    If the listener is not in the internal listener list, nothing happens.
    
    Parameters:
    
    listener - The listener to remove. Will be ignored if null.
  - close
```
public boolean close(java.io.Closeable closeable)
```
    Close the given closeable ignoring any exception and checking for null before closing. Returns true, if the object was closed successfully, false otherwise.
  - executeExternal
```
public ProcessExecutionResult executeExternal(java.io.File execDir,
                                              java.lang.String command,
                                              java.lang.String... args)
                                       throws java.io.IOException
```
    Executes the specified external command with the given arguments in the specified execution directory and returns the combined result data in an object.
    
    Parameters:
    
    execDir - The directory in which the command execution should take place (may be null).
    
    command - The name of the command or program to execute (must not be null).
    
    args - An optional list of arguments to be passed to the external command.
    
    Returns:
    
    An result object containing the exit code of the external command and the lines written to stdout.
    
    Throws:
    
    java.io.IOException - In any case of problems with the file system.
  - getConfigValue
```
public java.lang.String getConfigValue(java.lang.String sysPropName,
                                       java.lang.String envVarName)
```
    Returns the value of an external configuration setting by checking first a system property and if that is not set an environment variable. If that's also not set null will be returned.
    
    Parameters:
    
    sysPropName - The name of the system property to be checked (will be ignored if null).
    
    envVarName - The name of the environment variable to be checked (will be ignored if null).
    
    Returns:
    
    The first value detected or null.
  - getConfigValue
```
public java.lang.String getConfigValue(java.lang.String sysPropName,
                                       java.lang.String envVarName,
                                       java.lang.String defaultValue)
```
    Returns the value of an external configuration setting by checking first a system property and if that is not set an environment variable and finally if that's also not set returns the given default value.
    
    Parameters:
    
    sysPropName - The name of the system property to be checked (will be ignored if null).
    
    envVarName - The name of the environment variable to be checked (will be ignored if null).
    
    defaultValue - The value to be returned if no value was found by the other two settings (may be null).
    
    Returns:
    
    The first value detected or the default value.
  - notifyExitListeners
```
protected void notifyExitListeners(int rc)
```
    Inform all exit listeners that now the system will be exited.
    
    Parameters:
    
    rc - The return code for the exit.
  - determineIfEclipse
```
protected boolean determineIfEclipse()
```
    Returns true if the environment is based on eclipse. That is, this class is loaded within an eclipse plug-in. Can also be defined by setting system property "org.pf.util.isEclipse" to true or false.
  - reset
```
protected void reset()
```
  - getExitListeners
```
protected java.util.List<ISystemExitListener> getExitListeners()
```
  - setExitListeners
```
protected void setExitListeners(java.util.List<ISystemExitListener> newValue)
```

Class SysUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSU

DEBUG

OS_FAMILY_UNKNOWN

OS_FAMILY_WINDOWS

OS_FAMILY_UNIX

OS_FAMILY_MACINTOSH

JAVA_HOME_DIR

OS_PROPERTY_NAME

PF_OS_PROPERTY_NAME

SOLARIS

SUN_OS

LINUX

AIX

HP_UX

FREE_BSD

DIGITAL_UNIX

OSF1

IRIX

UNIX_SYSTEMS

Constructor Detail

SysUtil

Method Detail

current

checkIfWindows

determineOsFamilyName

determineOsFamilyName

isWindows

isEclipse

isAppletEnvironment

isExecutingWithJDK

getJdkBinaryDir

getOsFamily

getJavaRuntimeVersion

isJavaModuleSystemSupportingRuntime

sleep

exit

exit

addSystemExitListener

removeSystemExitListener

close

executeExternal

getConfigValue

getConfigValue

notifyExitListeners

determineIfEclipse

reset

getExitListeners

setExitListeners