Module org.basinmc.lavatory

Package org.basinmc.lavatory.rule.system

Enum OperatingSystem

java.lang.Object

java.lang.Enum<OperatingSystem>

org.basinmc.lavatory.rule.system.OperatingSystem

All Implemented Interfaces:

Serializable, Comparable<OperatingSystem>

public enum OperatingSystem
extends Enum<OperatingSystem>

Provides a list of operating systems which are officially supported and recognized (as well as a fallback value which is used when the operating system is unknown).

Author:

Johannes Donath

Enum Constant Summary

Enum Constants

Enum Constant	Description
LINUX
MAC_OS
UNKNOWN
WINDOWS

Method Summary

Modifier and Type	Method	Description
static Optional<OperatingSystem>	byKey(String key)	Retrieves an operating system based on its identification key.
static OperatingSystem	current()	Retrieves the operating system on which the application is currently being executed (or UNKNOWN if the operating system is not detected correctly).
String	getKey()
static OperatingSystem	valueOf(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

UNKNOWN

public static final OperatingSystem UNKNOWN

LINUX

public static final OperatingSystem LINUX

MAC_OS

public static final OperatingSystem MAC_OS

WINDOWS

public static final OperatingSystem WINDOWS

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(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:

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

NullPointerException - if the argument is null

current

@NonNull
public static OperatingSystem current()

Retrieves the operating system on which the application is currently being executed (or UNKNOWN if the operating system is not detected correctly).

Returns:

an operating system.

byKey

@NonNull
public static Optional<OperatingSystem> byKey(@NonNull
                                              String key)

Retrieves an operating system based on its identification key.

Parameters:

key - a key.

Returns:

an operating system or, if none matches, an empty optional.

getKey

@Nullable
public String getKey()