net.covers1624.quack.platform

Enum OperatingSystem

java.lang.Object

java.lang.Enum<OperatingSystem>

net.covers1624.quack.platform.OperatingSystem

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OperatingSystem>

public enum OperatingSystem
extends java.lang.Enum<OperatingSystem>

Represents an OperatingSystem.

Contains functions for Operating System lookup, and platform specific actions.

Created by covers1624 on 11/11/21.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREEBSD
LINUX
MACOS
SOLARIS
UNKNOWN Unknown OperatingSystem.
WINDOWS

Method Summary

Modifier and Type	Method and Description
static OperatingSystem	current() Returns the current OperatingSystem.
java.lang.String	exeSuffix(java.lang.String file) Appends the system specific common executable suffix to a file name.
boolean	isFreebsd()
boolean	isLinux()
boolean	isMacos()
boolean	isSolaris()
boolean	isUnixLike() If this Operating System is one of MACOS, LINUX, SOLARIS, or FREEBSD.
boolean	isWindows()
static OperatingSystem	parse(java.lang.String name) Parse an Operating System string.
static OperatingSystem	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OperatingSystem[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WINDOWS

public static final OperatingSystem WINDOWS

MACOS

public static final OperatingSystem MACOS

LINUX

public static final OperatingSystem LINUX

SOLARIS

public static final OperatingSystem SOLARIS

FREEBSD

public static final OperatingSystem FREEBSD

UNKNOWN

public static final OperatingSystem UNKNOWN

Unknown OperatingSystem. Doing operations with this OS, will throw UnsupportedOperationException's.

Method Detail

values

public static OperatingSystem[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OperatingSystem c : OperatingSystem.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OperatingSystem valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

current

public static OperatingSystem current()

Returns the current OperatingSystem.

Returns:

The OperatingSystem.

parse

public static OperatingSystem parse(java.lang.String name)

Parse an Operating System string.

This method will support the result of System.getProperty(java.lang.String) with the key of os.name.

Parameters:

name - The name to parse.

Returns:

The OperatingSystem. Will return UNKNOWN if the Operating System is not known.

isWindows

public boolean isWindows()

Returns:

If this Operating System is literal WINDOWS

isMacos

public boolean isMacos()

Returns:

If this Operating System is literal MACOS

isLinux

public boolean isLinux()

Returns:

If this Operating System is literal LINUX

isSolaris

public boolean isSolaris()

Returns:

If this Operating System is literal SOLARIS

isFreebsd

public boolean isFreebsd()

Returns:

If this Operating System is literal FREEBSD

isUnixLike

public boolean isUnixLike()

If this Operating System is one of MACOS, LINUX, SOLARIS, or FREEBSD.

Returns:

If this Operating System us unix/posix-like.

exeSuffix

public java.lang.String exeSuffix(java.lang.String file)

Appends the system specific common executable suffix to a file name.

Parameters:

file - The file name to append to.

Returns:

The file name with the suffix attached.