io.github.cegredev.josi

Enum OS

java.lang.Object

java.lang.Enum<OS>

io.github.cegredev.josi.OS

All Implemented Interfaces:

Serializable, Comparable<OS>

public enum OS
extends Enum<OS>

A list of various operating systems, each belonging to a OS.Family. Contains the current operating system and utility methods to help deal with different operating systems.

Author:

cegredev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OS.Family Families of operating systems, like Windows, Mac and Linux.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCH_LINUX
CENTOS
DEBIAN
FEDORA
GENTOO
LINUX_MINT
LINUX_UNKNOWN An unknown or at least unrecognizable Linux based operating system.
MAC_OS_BIG_SUR
MAC_OS_CATALINA
MAC_OS_HIGH_SIERRA
MAC_OS_MOJAVE
MAC_OS_SIERRA
MAC_OSX_CHEETAH
MAC_OSX_EL_CAPITAN
MAC_OSX_JAGUAR
MAC_OSX_LEOPARD
MAC_OSX_LION
MAC_OSX_MAVERICKS
MAC_OSX_MOUNTAIN_LION
MAC_OSX_PANTHER
MAC_OSX_PUMA
MAC_OSX_SNOW_LEOPARD
MAC_OSX_TIGER
MAC_OSX_YOSEMITE
MAC_UNKNOWN An unknown or at least unrecognizable Mac based operating system.
RED_HAT_ENTERPRISE_LINUX
SOLARIS The Solaris operating system.
SUSE Suse/OpenSUSE and any child-distributions.
UBUNTU
UNKNOWN An operating system that cannot be classified.
WIN_10
WIN_7
WIN_8
WIN_8_1
WIN_95
WIN_98
WIN_UNKNOWN An unknown or at least unrecognizable Windows based operating system.
WIN_VISTA
WIN_XP

Method Summary

Modifier and Type	Method and Description
static OS	current()
void	enforce(OS... operatingSystems) Throws an UnsupportedOSException if this operating system is not part of the given array.
void	enforceFamily(OS.Family... families) Throws an UnsupportedOSException if this OS is not part of the given families.
void	enforceNot(OS... operatingSystems) Throws an UnsupportedOSException if this operating system is part of the given array.
void	enforceNotFamily(OS.Family... families) Throws an UnsupportedOSException if this OS's family is part of the given families.
OS.Family	getFamily()
boolean	is(OS... operatingSystems) Checks if this OS is part of the given array.
boolean	isFamily(OS.Family... families) Checks if this OS is part of the given families.
<T> T	pick(T windows, T mac, T linux) Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.
<T> T	pick(T windows, T mac, T linux, T other) Picks one of the given values based on the OS.Family of this operating system.
<T> T	pickLinux(T linux) Returns the given value if the OS.Family of this OS is Linux or else throws an UnsupportedOSException.
<T> T	pickLinuxAny(T linux, T anyOther) Returns the given value if the OS.Family of this operating system is Linux, or a default one.
<T> T	pickMac(T mac) Returns the given value if the OS.Family of this OS is Mac or else throws an UnsupportedOSException.
<T> T	pickMacAny(T mac, T anyOther) Returns the given value if the OS.Family of this operating system is Mac, or a default one.
<T> T	pickMacLinux(T mac, T linux) Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.
<T> T	pickMacLinuxAny(T mac, T linux, T anyOther) Picks one of the given values based on the OS.Family of this operating system or a default one.
<T> T	pickWindows(T windows) Returns the given value if the OS.Family of this OS is Windows or else throws an UnsupportedOSException.
<T> T	pickWindowsAny(T windows, T anyOther) Returns the given value if the OS.Family of this operating system is Windows, or a default one.
<T> T	pickWinLinux(T windows, T linux) Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.
<T> T	pickWinLinuxAny(T windows, T linux, T anyOther) Picks one of the given values based on the OS.Family of this operating system or a default one.
<T> T	pickWinMac(T windows, T mac) Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.
<T> T	pickWinMacAny(T windows, T mac, T anyOther) Picks one of the given values based on the OS.Family of this operating system or a default one.
static OS	valueOf(String name) Returns the enum constant of this type with the specified name.
static OS[]	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

WIN_95

public static final OS WIN_95

WIN_98

public static final OS WIN_98

WIN_XP

public static final OS WIN_XP

WIN_VISTA

public static final OS WIN_VISTA

WIN_7

public static final OS WIN_7

WIN_8

public static final OS WIN_8

WIN_8_1

public static final OS WIN_8_1

WIN_10

public static final OS WIN_10

WIN_UNKNOWN

public static final OS WIN_UNKNOWN

An unknown or at least unrecognizable Windows based operating system.

MAC_OSX_CHEETAH

public static final OS MAC_OSX_CHEETAH

MAC_OSX_PUMA

public static final OS MAC_OSX_PUMA

MAC_OSX_JAGUAR

public static final OS MAC_OSX_JAGUAR

MAC_OSX_PANTHER

public static final OS MAC_OSX_PANTHER

MAC_OSX_TIGER

public static final OS MAC_OSX_TIGER

MAC_OSX_LEOPARD

public static final OS MAC_OSX_LEOPARD

MAC_OSX_SNOW_LEOPARD

public static final OS MAC_OSX_SNOW_LEOPARD

MAC_OSX_LION

public static final OS MAC_OSX_LION

MAC_OSX_MOUNTAIN_LION

public static final OS MAC_OSX_MOUNTAIN_LION

MAC_OSX_MAVERICKS

public static final OS MAC_OSX_MAVERICKS

MAC_OSX_YOSEMITE

public static final OS MAC_OSX_YOSEMITE

MAC_OSX_EL_CAPITAN

public static final OS MAC_OSX_EL_CAPITAN

MAC_OS_SIERRA

public static final OS MAC_OS_SIERRA

MAC_OS_HIGH_SIERRA

public static final OS MAC_OS_HIGH_SIERRA

MAC_OS_MOJAVE

public static final OS MAC_OS_MOJAVE

MAC_OS_CATALINA

public static final OS MAC_OS_CATALINA

MAC_OS_BIG_SUR

public static final OS MAC_OS_BIG_SUR

MAC_UNKNOWN

public static final OS MAC_UNKNOWN

An unknown or at least unrecognizable Mac based operating system.

DEBIAN

public static final OS DEBIAN

UBUNTU

public static final OS UBUNTU

GENTOO

public static final OS GENTOO

LINUX_MINT

public static final OS LINUX_MINT

RED_HAT_ENTERPRISE_LINUX

public static final OS RED_HAT_ENTERPRISE_LINUX

CENTOS

public static final OS CENTOS

FEDORA

public static final OS FEDORA

ARCH_LINUX

public static final OS ARCH_LINUX

SUSE

public static final OS SUSE

Suse/OpenSUSE and any child-distributions.

LINUX_UNKNOWN

public static final OS LINUX_UNKNOWN

An unknown or at least unrecognizable Linux based operating system.

SOLARIS

public static final OS SOLARIS

The Solaris operating system.

UNKNOWN

public static final OS UNKNOWN

An operating system that cannot be classified.

Method Detail

values

public static OS[] 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 (OS c : OS.values())
    System.out.println(c);

Returns:

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

valueOf

public static OS 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

public static OS current()

Returns:

The current operating system.

pick

public <T> T pick(T windows,
                  T mac,
                  T linux,
                  T other)

Picks one of the given values based on the OS.Family of this operating system.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

mac - The value if the OS family is OS.Family.MAC.

linux - The value if the OS family is OS.Family.LINUX.

other - The value if the OS family is OS.Family.OTHER.

Returns:

The value representing this operating system.

pick

public <T> T pick(T windows,
                  T mac,
                  T linux)

Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

mac - The value if the OS family is OS.Family.MAC.

linux - The value if the OS family is OS.Family.LINUX.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is none of the above mentioned options.

pickWinMacAny

public <T> T pickWinMacAny(T windows,
                           T mac,
                           T anyOther)

Picks one of the given values based on the OS.Family of this operating system or a default one.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

mac - The value if the OS family is OS.Family.MAC.

anyOther - The value if the OS is neither Windows or Mac.

Returns:

The value representing this operating system.

pickWinMac

public <T> T pickWinMac(T windows,
                        T mac)

Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

mac - The value if the OS family is OS.Family.MAC.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is none of the above mentioned options.

pickWinLinuxAny

public <T> T pickWinLinuxAny(T windows,
                             T linux,
                             T anyOther)

Picks one of the given values based on the OS.Family of this operating system or a default one.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

linux - The value if the OS family is OS.Family.LINUX.

anyOther - The value if the OS is neither Windows or Linux.

Returns:

The value representing this operating system.

pickWinLinux

public <T> T pickWinLinux(T windows,
                          T linux)

Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

linux - The value if the OS family is OS.Family.LINUX.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is none of the above mentioned options.

pickMacLinuxAny

public <T> T pickMacLinuxAny(T mac,
                             T linux,
                             T anyOther)

Picks one of the given values based on the OS.Family of this operating system or a default one.

Type Parameters:

T - The type of the value.

Parameters:

mac - The value if the OS family is OS.Family.MAC.

linux - The value if the OS family is OS.Family.LINUX.

anyOther - The value if the OS is neither Mac or Linux.

Returns:

The value representing this operating system.

pickMacLinux

public <T> T pickMacLinux(T mac,
                          T linux)

Picks one of the given values based on the OS.Family of this operating system or throws an UnsupportedOSException if there is no value to represent it.

Type Parameters:

T - The type of the value.

Parameters:

mac - The value if the OS family is OS.Family.MAC.

linux - The value if the OS family is OS.Family.LINUX.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is none of the above mentioned options.

pickWindowsAny

public <T> T pickWindowsAny(T windows,
                            T anyOther)

Returns the given value if the OS.Family of this operating system is Windows, or a default one.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

anyOther - The value if the OS is anything other than Windows.

Returns:

The value representing this operating system.

pickWindows

public <T> T pickWindows(T windows)

Returns the given value if the OS.Family of this OS is Windows or else throws an UnsupportedOSException.

Type Parameters:

T - The type of the value.

Parameters:

windows - The value if the OS family is OS.Family.WINDOWS.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is not Windows.

pickMacAny

public <T> T pickMacAny(T mac,
                        T anyOther)

Returns the given value if the OS.Family of this operating system is Mac, or a default one.

Type Parameters:

T - The type of the value.

Parameters:

mac - The value if the OS family is OS.Family.MAC.

anyOther - The value if the OS is anything other than Mac.

Returns:

The value representing this operating system.

pickMac

public <T> T pickMac(T mac)

Returns the given value if the OS.Family of this OS is Mac or else throws an UnsupportedOSException.

Type Parameters:

T - The type of the value.

Parameters:

mac - The value if the OS family is OS.Family.MAC.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is not Mac.

pickLinuxAny

public <T> T pickLinuxAny(T linux,
                          T anyOther)

Returns the given value if the OS.Family of this operating system is Linux, or a default one.

Type Parameters:

T - The type of the value.

Parameters:

linux - The value if the OS family is OS.Family.LINUX.

anyOther - The value if the OS is anything other than Linux.

Returns:

The value representing this operating system.

pickLinux

public <T> T pickLinux(T linux)

Returns the given value if the OS.Family of this OS is Linux or else throws an UnsupportedOSException.

Type Parameters:

T - The type of the value.

Parameters:

linux - The value if the OS family is OS.Family.LINUX.

Returns:

The value representing this operating system.

Throws:

UnsupportedOSException - If this operating system is not Linux.

isFamily

public boolean isFamily(OS.Family... families)

Checks if this OS is part of the given families.

Parameters:

families - An array of families this OS's family has to be part of.

Returns:

If this OS's family is part of the given families.

enforceNotFamily

public void enforceNotFamily(OS.Family... families)

Throws an UnsupportedOSException if this OS's family is part of the given families.

Parameters:

families - An array of families that this OS's family is not allowed to be part of.

Throws:

UnsupportedOSException - If the this operating system's family is part of the given array.

enforceFamily

public void enforceFamily(OS.Family... families)

Throws an UnsupportedOSException if this OS is not part of the given families.

Parameters:

families - An array of families that this OS's family has to be part of.

Throws:

UnsupportedOSException - If this operating system's family is not part of the given array.

is

public boolean is(OS... operatingSystems)

Checks if this OS is part of the given array.

Parameters:

operatingSystems - An array of operating systems this OS has to be part of.

Returns:

If this OS is part of the given array.

enforceNot

public void enforceNot(OS... operatingSystems)

Throws an UnsupportedOSException if this operating system is part of the given array.

Parameters:

operatingSystems - An array of operating systems that this OS is not allowed to be part of.

Throws:

UnsupportedOSException - If this operating system is part of the given array.

enforce

public void enforce(OS... operatingSystems)

Throws an UnsupportedOSException if this operating system is not part of the given array.

Parameters:

operatingSystems - An array of operating systems that this OS has to be part of.

Throws:

UnsupportedOSException - If this operating system is not part of the given array.

getFamily

public OS.Family getFamily()

Returns:

The family this OS belongs to.