Package org.ossreviewtoolkit.utils.common

Object Os

  • All Implemented Interfaces:
    
public class Os

    Operating-System-specific utility functions.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String fixupUserHomeProperty() Check if the "user.home" property is set to a sane value and otherwise set it to the value of an (OS-specific) environment variable for the user home directory, and return that value.
      final File getPathFromEnvironment(String executable) Return the full path to the given executable file if it is in the system's PATH environment, or null otherwise.
      final File resolveExecutable(File executable) Resolve the executable to its full name including any optional Windows extension.
      final <Error class: unknown class> getName() The operating system name.
      final Boolean isLinux() Whether the operating system is Linux or not.
      final Boolean isMac() Whether the operating system is macOS or not.
      final Boolean isWindows() Whether the operating system is Windows or not.
      final <Error class: unknown class> getEnv() The currently set environment variables.
      final <Error class: unknown class> getUserHomeDirectory() The current user's home directory.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • fixupUserHomeProperty

         final String fixupUserHomeProperty()

        Check if the "user.home" property is set to a sane value and otherwise set it to the value of an (OS-specific) environment variable for the user home directory, and return that value. This works around the issue that esp. in certain Docker scenarios "user.home" is set to "?", see https://bugs.openjdk.java.net/browse/JDK-8193433 for some background information.

      • getPathFromEnvironment

         final File getPathFromEnvironment(String executable)

        Return the full path to the given executable file if it is in the system's PATH environment, or null otherwise.

      • getName

         final <Error class: unknown class> getName()

        The operating system name.

      • isLinux

         final Boolean isLinux()

        Whether the operating system is Linux or not.

      • isMac

         final Boolean isMac()

        Whether the operating system is macOS or not.

      • isWindows

         final Boolean isWindows()

        Whether the operating system is Windows or not.

      • getEnv

         final <Error class: unknown class> getEnv()

        The currently set environment variables. Keys are case-insensitive on Windows.

      • getUserHomeDirectory

         final <Error class: unknown class> getUserHomeDirectory()

        The current user's home directory.