com.exasol.projectkeeper.OsCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of project-keeper-core Show documentation

Project keeper is a tool that verifies and fixes project setups.

There is a newer version: 4.4.0

package com.exasol.projectkeeper;

import java.util.Locale;

/**
 * Helper class to check the operating system this Java VM runs in.
 *
 * Please keep the notes below as a pseudo-license:
 *
 * http://stackoverflow.com/questions/228477/how-do-i-programmatically-determine-operating-system-in-java compare to
 * http://svn.terracotta.org/svn/tc/dso/tags/2.6.4/code/base/common/src/com/tc/util/runtime/Os.java
 * http://www.docjar.com/html/api/org/apache/commons/lang/SystemUtils.java.html
 */
public class OsCheck {
    /**
     * Types of Operating Systems
     */
    public enum OSType {
        /** Windows operating system */
        WINDOWS,
        /** macOS operating system */
        MACOS,
        /** Linux operating system */
        LINUX,
        /** Unknown operating system */
        OTHER
    }

    /**
     * @param suffixForWindows suffix for command on operating system windows
     * @return if detected operating system is windows then return the provided command suffix otherwise return empty
     *         string.
     */
    public static String suffix(final String suffixForWindows) {
        return detectOperatingSystemType() == OSType.WINDOWS ? suffixForWindows : "";
    }

    /**
     * Detect the operating system from the {@code os.name} System property.
     *
     * @return the operating system detected
     */
    public OSType getOperatingSystemType() {
        return detectOperatingSystemType();
    }

    private static OSType detectOperatingSystemType() {
        final String os = System.getProperty("os.name", "generic").toLowerCase(Locale.ENGLISH);
        if ((os.indexOf("mac") >= 0) || (os.indexOf("darwin") >= 0)) {
            return OSType.MACOS;
        } else if (os.indexOf("win") >= 0) {
            return OSType.WINDOWS;
        } else if (os.indexOf("linux") >= 0) {
            return OSType.LINUX;
        }
        return OSType.OTHER;
    }
}