OperatingSystem (Grolifant Core API)

org.ysb33r.grolifant5.api.core.OperatingSystem

@groovy.transform.CompileStatic
abstract class OperatingSystem
extends Object

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static enum`	`OperatingSystem.Arch`	Enumeration representing common hardware-operating system architectures.

Field Summary

Fields
Modifiers	Name	Description
`protected static String`	`OS_ARCH`
`protected static String`	`OS_NAME`
`protected static String`	`OS_VERSION`

Properties Summary

Properties
Type	Name and description
`String`	`name` The short name for the current operating system.
`String`	`pathVar` Name of environmental variable that holds the system search path
`String`	`version` The version for the current operating system.

Constructor Summary

Constructors
Constructor and description
`protected OperatingSystem ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static OperatingSystem`	`current()`
	`java.util.List<File>`	`findAllInPath(String name)` Find all files in system search path of a certain name.
	`File`	`findInPath(String name)` Locates the given exe in the system path.
	`abstract Arch`	`getArch()` Architecture underlying the operating system
	`abstract String`	`getArchStr()` Architecture underlying the operating system
	`abstract java.util.List<String>`	`getExecutableNames(String executablePath)` Returns list of possible OS-specific decorated exe names.
	`java.util.List<File>`	`getPath()` List of system search paths
	`String`	`getPathSeparator()` The character used to separate elements in a system search path
	`abstract String`	`getSharedLibraryName(String libraryName)` Returns OS-specific shared library name
	`abstract String`	`getSharedLibrarySuffix()` OS-dependent string that is used to suffix to shared libraries
	`abstract String`	`getStaticLibraryName(String libraryName)` Returns OS-specific static library name
	`abstract String`	`getStaticLibrarySuffix()` OS-dependent string that is used to suffix to static libraries
	`boolean`	`isFreeBSD()` Check is this is FreeBSD
	`boolean`	`isLinux()` Check is this is a Linux flavour
	`boolean`	`isMacOsX()` Check is this is Apple Mac OS X
	`boolean`	`isNetBSD()` Check is this is NetBSD
	`boolean`	`isSolaris()` Check is this is a Solaris flavour
	`boolean`	`isUnix()` Check is this is any kind of Unix-like O/S
	`boolean`	`isWindows()` Check is this is Microsoft Windows
	`String`	`toString()` Stringize implementation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - protected static final String OS_ARCH
  - protected static final String OS_NAME
  - protected static final String OS_VERSION
- Property Detail
  - final String name
    
    The short name for the current operating system. Possibly the same as System.getProperty( "os.name" ).
  - final String pathVar
    
    Name of environmental variable that holds the system search path
  - final String version
    
    The version for the current operating system.
- Constructor Detail
  - protected OperatingSystem()
- Method Detail
  - static OperatingSystem current()
  - java.util.List<File> findAllInPath(String name)
    
    Find all files in system search path of a certain name.
    Parameters:
    name - Name to look for
    Returns:
    List of files
  - File findInPath(String name)
    
    Locates the given exe in the system path.
    Parameters:
    name - Name of exe to search for.
    Returns:
    Executable location of null if not found.
  - abstract Arch getArch()
    
    Architecture underlying the operating system
    Returns:
    Architecture type. Returns OperatingSystem.Arch.UNKNOWN is it cannot be identified. In that a caller might need to use getArchStr() to help with identification.
  - abstract String getArchStr()
    
    Architecture underlying the operating system
    Returns:
    Architecture string
  - abstract java.util.List<String> getExecutableNames(String executablePath)
    
    Returns list of possible OS-specific decorated exe names.
    Parameters:
    executablePath - Name of exe
    Returns:
    Returns a list of possible appropriately decorated exes
  - java.util.List<File> getPath()
    
    List of system search paths
    Returns:
    List of entries (can be empty).
  - String getPathSeparator()
    
    The character used to separate elements in a system search path
    Returns:
    OS-specific separator.
  - abstract String getSharedLibraryName(String libraryName)
    
    Returns OS-specific shared library name
    Parameters:
    libraryName - This can be a base name or a full name.
    Returns:
    Shared library name.
  - abstract String getSharedLibrarySuffix()
    
    OS-dependent string that is used to suffix to shared libraries
    Returns:
    Shared library suffix
  - abstract String getStaticLibraryName(String libraryName)
    
    Returns OS-specific static library name
    Parameters:
    libraryName - This can be a base name or a full name.
    Returns:
    Static library name.
  - abstract String getStaticLibrarySuffix()
    
    OS-dependent string that is used to suffix to static libraries
    Returns:
    Static library suffix
  - boolean isFreeBSD()
    
    Check is this is FreeBSD
    Returns:
    true if FreeBSD
  - boolean isLinux()
    
    Check is this is a Linux flavour
    Returns:
    true if any kind of Linux
  - boolean isMacOsX()
    
    Check is this is Apple Mac OS X
    Returns:
    true if Mac OS X
  - boolean isNetBSD()
    
    Check is this is NetBSD
    Returns:
    true if NetBSD
  - boolean isSolaris()
    
    Check is this is a Solaris flavour
    Returns:
    true if Solaris
  - boolean isUnix()
    
    Check is this is any kind of Unix-like O/S
    Returns:
    true if any kind of Unix-like O/S
  - boolean isWindows()
    
    Check is this is Microsoft Windows
    Returns:
    true if Windows
  - String toString()
    
    Stringize implementation
    Returns:
    Name, Version and Architecture

Groovy Documentation

[Groovy] Class OperatingSystem

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final String OS_ARCH

protected static final String OS_NAME

protected static final String OS_VERSION

Property Detail

final String name

final String pathVar

final String version

Constructor Detail

protected OperatingSystem()

Method Detail

static OperatingSystem current()

java.util.List<File> findAllInPath(String name)

File findInPath(String name)

abstract Arch getArch()

abstract String getArchStr()

abstract java.util.List<String> getExecutableNames(String executablePath)

java.util.List<File> getPath()

String getPathSeparator()

abstract String getSharedLibraryName(String libraryName)

abstract String getSharedLibrarySuffix()

abstract String getStaticLibraryName(String libraryName)

abstract String getStaticLibrarySuffix()

boolean isFreeBSD()

boolean isLinux()

boolean isMacOsX()

boolean isNetBSD()

boolean isSolaris()

boolean isUnix()

boolean isWindows()

String toString()