SystemUtil (java-utils 1.0.2 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

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`	`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`	`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 boolean`	`isDebuggingEnabled()` Examines some system properties to determine whether the process is likely being debugged in an IDE or remotely.

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

- Method Detail
  - 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:
  - getRunningClassPath
```
public static String getRunningClassPath()
```
    Returns the running class path.
    
    Returns:
  - getTempDir
```
public static String getTempDir()
```
    Returns the temp directory of this platform.
    
    Returns:
  - 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 -
    
    _suffix -
    
    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 -
    
    Returns:
  - createTempDirectory
```
public static File createTempDirectory(String _path,
                                       String _name,
                                       boolean _deleteOnExit)
```
    Creates a new temporary directory in the given path.
    
    Parameters:
    
    _path -
    
    _name -
    
    _deleteOnExit -
    
    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:
  - 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 -
    
    Returns:
    
    extension, empty string if not 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 -
    
    Returns:
    
    file object, never null
    
    Throws:
    
    IOException
  - formatBytesHumanReadable
```
public static String formatBytesHumanReadable(long _bytes,
                                              boolean _use1000BytesPerMb)
```
    Formats a file size given in byte to something human readable.
    
    Parameters:
    
    _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.
    
    Returns:
    
    version or null

Class SystemUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getHostName

getWorkingDirectory

getRunningClassPath

getTempDir

concatFilePath

concatFilePath

appendSuffixIfMissing

appendTrailingDelimiter

createTempDirectory

createTempDirectory

isDebuggingEnabled

getFileExtension

getFileIfReadable

formatBytesHumanReadable

getApplicationVersionFromJar