SystemUtil (java-utils 1.0.3 API)

java.lang.Object
- com.github.hypfvieh.util.SystemUtil

```
public final class SystemUtil
extends Object
```
Utility-Class with various operating system related helper methods.

Since:

v0.0.5 - 2015-08-05

Author:

hypfvieh

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILE_SEPARATOR` Character that separates components of a file path.
`static String`	`LINE_SEPARATOR` Sequence used by operating system to separate lines in text files.
`static String`	`TMP_DIR` The system's temporary-file directory.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`appendSuffixIfMissing(String _str, String _suffix)` Append a suffix to the string (e.g. filename) if it doesn't have it already.
`static String`	`appendTrailingDelimiter(String _filePath)` Appends the OS specific path delimiter to the end of the String, if it is missing.
`static String`	`concatFilePath(boolean _includeTrailingDelimiter, String... _parts)` Concats a path from all given parts, using the path delimiter for the currently used platform.
`static String`	`concatFilePath(String... _parts)` Concats a path from all given parts, using the path delimiter for the currently used platform.
`static File`	`createTempDirectory(String _path, String _name, boolean _deleteOnExit)` Creates a new temporary directory in the given path.
`static File`	`createTempDirectory(String _path, String _prefix, int _length, boolean _timestamp, boolean _deleteOnExit)` Creates a temporary directory in the given path.
`static String`	`formatBytesHumanReadable(long _bytes, boolean _use1000BytesPerMb)` Formats a file size given in byte to something human readable.
`static String`	`getApplicationVersionFromJar(Class<?> _class, String _default)` Read the JARs manifest and try to get the current program version from it.
`static String`	`getCurrentUser()` Determines the current logged on user.
`static String`	`getFileExtension(File _file)` Extracts the file extension (part behind last dot of a filename).
`static String`	`getFileExtension(String _fileName)` Extracts the file extension (part behind last dot of a filename).
`static File`	`getFileIfReadable(String _file)` Checks if given String is a valid file, e.g. file exists, is really a file and can be read.
`static String`	`getHostName()` Gets the host name of the local machine.
`static String`	`getJavaVersion()` Determines the Java version of the executing JVM.
`static String`	`getOs()` Determines the operating system's type and version.
`static String`	`getRunningClassPath()` Returns the running class path.
`static String`	`getTempDir()` Returns the temp directory of this platform.
`static String`	`getWorkingDirectory()` Returns the current working directory.
`static String`	`guessDefaultTerminal()` Tries to find the "default" terminal emulator.
`static boolean`	`isDebuggingEnabled()` Examines some system properties to determine whether the process is likely being debugged in an IDE or remotely.
`static String`	`normalizePath(String _path)` Normalize a file system path expression for the current OS.
`static String`	`normalizePath(String _path, boolean _appendFinalSeparator)` Normalize a file system path expression for the current OS.

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

- Field Detail
  - FILE_SEPARATOR
```
public static final String FILE_SEPARATOR
```
    Character that separates components of a file path. This is "/" on UNIX and "\" on Windows.
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
    Sequence used by operating system to separate lines in text files.
  - TMP_DIR
```
public static final String TMP_DIR
```
    The system's temporary-file directory.
- Method Detail
  - getOs
```
public static String getOs()
```
    Determines the operating system's type and version.
    
    Returns:
    
    the OS type and version as a string
  - getHostName
```
public static String getHostName()
```
    Gets the host name of the local machine.
    
    Returns:
    
    host name
  - getWorkingDirectory
```
public static String getWorkingDirectory()
```
    Returns the current working directory.
    
    Returns:
    
    current working dir
  - getRunningClassPath
```
public static String getRunningClassPath()
```
    Returns the running class path.
    
    Returns:
    
    String with classpath
  - getTempDir
```
public static String getTempDir()
```
    Returns the temp directory of this platform.
    
    Returns:
    
    temp directory
  - getJavaVersion
```
public static String getJavaVersion()
```
    Determines the Java version of the executing JVM.
    
    Returns:
    
    Java version
  - getCurrentUser
```
public static String getCurrentUser()
```
    Determines the current logged on user.
    
    Returns:
    
    logged on user
  - concatFilePath
```
public static String concatFilePath(boolean _includeTrailingDelimiter,
                                    String... _parts)
```
    Concats a path from all given parts, using the path delimiter for the currently used platform.
    
    Parameters:
    
    _includeTrailingDelimiter - include delimiter after last token
    
    _parts - parts to concat
    
    Returns:
    
    concatinated string
  - concatFilePath
```
public static String concatFilePath(String... _parts)
```
    Concats a path from all given parts, using the path delimiter for the currently used platform. Does not include trailing delimiter.
    
    Parameters:
    
    _parts - parts to concat
    
    Returns:
    
    concatinated string
  - appendSuffixIfMissing
```
public static String appendSuffixIfMissing(String _str,
                                           String _suffix)
```
    Append a suffix to the string (e.g. filename) if it doesn't have it already.
    
    Parameters:
    
    _str - string to check
    
    _suffix - suffix to append
    
    Returns:
    
    string with suffix or original if no suffix was appended
  - appendTrailingDelimiter
```
public static String appendTrailingDelimiter(String _filePath)
```
    Appends the OS specific path delimiter to the end of the String, if it is missing.
    
    Parameters:
    
    _filePath - file path
    
    Returns:
    
    String
  - createTempDirectory
```
public static File createTempDirectory(String _path,
                                       String _name,
                                       boolean _deleteOnExit)
```
    Creates a new temporary directory in the given path.
    
    Parameters:
    
    _path - path
    
    _name - directory name
    
    _deleteOnExit - delete directory on jvm shutdown
    
    Returns:
    
    created Directory, null if directory/file was already existing
  - createTempDirectory
```
public static File createTempDirectory(String _path,
                                       String _prefix,
                                       int _length,
                                       boolean _timestamp,
                                       boolean _deleteOnExit)
```
    Creates a temporary directory in the given path. You can specify certain files to get a random unique name.
    
    Parameters:
    
    _path - where to place the temp folder
    
    _prefix - prefix of the folder
    
    _length - length of random chars
    
    _timestamp - add timestamp (yyyyMMdd_HHmmss-SSS) to directory name
    
    _deleteOnExit - mark directory for deletion on jvm termination
    
    Returns:
    
    file
  - isDebuggingEnabled
```
public static boolean isDebuggingEnabled()
```
    Examines some system properties to determine whether the process is likely being debugged in an IDE or remotely.
    
    Returns:
    
    true if being debugged, false otherwise
  - getFileExtension
```
public static String getFileExtension(String _fileName)
```
    Extracts the file extension (part behind last dot of a filename). Only returns the extension, without the leading dot.
    
    Parameters:
    
    _fileName - filename
    
    Returns:
    
    extension, empty string if no dot was found in filename or null if given String was null
  - getFileExtension
```
public static String getFileExtension(File _file)
```
    Extracts the file extension (part behind last dot of a filename). Only returns the extension, without the leading dot.
    
    Parameters:
    
    _file - file
    
    Returns:
    
    extension, empty string if no dot was found in filename or null if given String was null
  - getFileIfReadable
```
public static File getFileIfReadable(String _file)
                              throws IOException
```
    Checks if given String is a valid file, e.g. file exists, is really a file and can be read. Throws IOException or Subclass of it, if file is either non-existing, not a file or unreadable.
    
    Parameters:
    
    _file - filename
    
    Returns:
    
    file object, never null
    
    Throws:
    
    IOException - if file could not be read
  - formatBytesHumanReadable
```
public static String formatBytesHumanReadable(long _bytes,
                                              boolean _use1000BytesPerMb)
```
    Formats a file size given in byte to something human readable.
    
    Parameters:
    
    _bytes - size in bytes
    
    _use1000BytesPerMb - use 1000 bytes per MByte instead of 1024
    
    Returns:
    
    String
  - getApplicationVersionFromJar
```
public static String getApplicationVersionFromJar(Class<?> _class,
                                                  String _default)
```
    Read the JARs manifest and try to get the current program version from it.
    
    Parameters:
    
    _class - class to use as entry point
    
    _default - default string to use if version could not be found
    
    Returns:
    
    version or null
  - guessDefaultTerminal
```
public static String guessDefaultTerminal()
```
    Tries to find the "default" terminal emulator. This will be cmd.exe on windows and may vary on linux/unix systems depending on installed terminal programs. On linux/unix there is no generic way to find the default terminal, so all known terminal programs will be tried until any of them is found.
    
    Returns:
    
    String with terminal name or null if terminal could not be determined
  - normalizePath
```
public static String normalizePath(String _path,
                                   boolean _appendFinalSeparator)
```
    Normalize a file system path expression for the current OS. Replaces path separators by this OS's path separator. Appends a final path separator if parameter is set and if not yet present.
    
    Parameters:
    
    _path - path
    
    _appendFinalSeparator - controls appendix of separator at the end
    
    Returns:
    
    normalized path
  - normalizePath
```
public static String normalizePath(String _path)
```
    Normalize a file system path expression for the current OS. Replaces path separators by this OS's path separator. Appends a final path separator unless present.
    
    Parameters:
    
    _path - path
    
    Returns:
    
    normalized path

Class SystemUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE_SEPARATOR

LINE_SEPARATOR

TMP_DIR

Method Detail

getOs

getHostName

getWorkingDirectory

getRunningClassPath

getTempDir

getJavaVersion

getCurrentUser

concatFilePath

concatFilePath

appendSuffixIfMissing

appendTrailingDelimiter

createTempDirectory

createTempDirectory

isDebuggingEnabled

getFileExtension

getFileExtension

getFileIfReadable

formatBytesHumanReadable

getApplicationVersionFromJar

guessDefaultTerminal

normalizePath

normalizePath