Windows (grolifant 0.12.1 API)

org.ysb33r.grolifant.api.os.Windows

Windows implementation of OperatingSystem.

Inherited fields
Fields inherited from class	Fields
`class OperatingSystem`	`OS_ARCH, OS_NAME, OS_VERSION`

Properties Summary

Properties
Type	Name and description
`static OperatingSystem`	`INSTANCE`

Constructor Summary

Constructors
Constructor and description
`protected Windows ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Arch`	`getArch()` Architecture underlying the operating system
	`String`	`getArchStr()` Architecture underlying the operating system
	`String`	`getExecutableName(String executablePath)`
	`String`	`getPathVar()` Returns Windows system seach path environmental variable name.
	`String`	`getScriptName(String scriptPath)` Returns Windows-specific decorated script name.
	`String`	`getSharedLibraryName(String libraryName)` Returns Windows shared library name
	`String`	`getSharedLibrarySuffix()` Return Windows string that is used to suffix to shared libraries
	`String`	`getStaticLibraryName(String libraryName)` Returns OS-specific static library name
	`String`	`getStaticLibrarySuffix()` Windows string that is used to suffix to static libraries
	`boolean`	`isWindows()` Confirms this is a representation of the Microsoft Windows operating system.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class OperatingSystem`	`current, findAllInPath, findInPath, getArch, getArchStr, getExecutableName, getName, getPath, getPathSeparator, getPathVar, getScriptName, getSharedLibraryName, getSharedLibrarySuffix, getStaticLibraryName, getStaticLibrarySuffix, getVersion, isFreeBSD, isLinux, isMacOsX, isNetBSD, isSolaris, isUnix, isWindows, toString`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - static final OperatingSystem INSTANCE
- Constructor Detail
  - protected Windows()
- Method Detail
  - @Override 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.
  - @Override String getArchStr()
    
    Architecture underlying the operating system
    Returns:
    amd64 or i386
  - @Override String getExecutableName(String executablePath)
  - @Override String getPathVar()
    
    Returns Windows system seach path environmental variable name.
    Returns:
    Path.
  - @Override String getScriptName(String scriptPath)
    
    Returns Windows-specific decorated script name.
    Parameters:
    scriptPath - Name of script.
    Returns:
    Returns a .bat based name.
  - @Override String getSharedLibraryName(String libraryName)
    
    Returns Windows shared library name
    Parameters:
    libraryName - This can be a base name or a full name.
    Returns:
    Shared library name with .dll extension
  - @Override String getSharedLibrarySuffix()
    
    Return Windows string that is used to suffix to shared libraries
    Returns:
    .dll
  - @Override 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.
  - @Override String getStaticLibrarySuffix()
    
    Windows string that is used to suffix to static libraries
    Returns:
    .lib
  - @Override boolean isWindows()
    
    Confirms this is a representation of the Microsoft Windows operating system.
    Returns:
    true

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Windows

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final OperatingSystem INSTANCE

Constructor Detail

protected Windows()

Method Detail

@Override Arch getArch()

@Override String getArchStr()

@Override String getExecutableName(String executablePath)

@Override String getPathVar()

@Override String getScriptName(String scriptPath)

@Override String getSharedLibraryName(String libraryName)

@Override String getSharedLibrarySuffix()

@Override String getStaticLibraryName(String libraryName)

@Override String getStaticLibrarySuffix()

@Override boolean isWindows()