Module dev.hydraulic.types

Package dev.hydraulic.types.machines

Interface OperatingSystem

All Superinterfaces:

MachineCompatibilityAspect

All Known Implementing Classes:

OperatingSystems

public interface OperatingSystem
extends MachineCompatibilityAspect

A type that represents an operating system or family of closely related operating systems.

This interface is implemented by the members of OperatingSystems. When writing code that wants to represent an operating system use this marker type instead of the values of OperatingSystems directly so others can create objects representing otherwise unknown operating systems and pass them into your code.

This interface doesn't add any additional properties over the MachineCompatibilityAspect interface.

Compatibility note: don't implement this interface unless you're willing to tolerate source breakage. Additional properties useful for identifying operating systems may be added here over time.

Method Summary

Static Methods

Modifier and Type	Method	Description
static OperatingSystem	from(String name)	Looks up an operating system in the OperatingSystems.ALIAS_MAP or throws UnrecognizedAliasException.
static OperatingSystem	fromOrNull(String name)	Lower-cases the name parameter and then looks it up in the OperatingSystems.ALIAS_MAP.
static OperatingSystem	fromOrUnknown(String name)	Same as from(java.lang.String) but returns OperatingSystems.UNKNOWN instead of throwing an exception if the name isn't recognized.

Methods inherited from interface dev.hydraulic.types.machines.MachineCompatibilityAspect

getAliases, getDisplayName, getIdentifier, getVendor

Method Details

fromOrNull

static OperatingSystem fromOrNull(String name)

Lower-cases the name parameter and then looks it up in the OperatingSystems.ALIAS_MAP.

Parameters:

name - The primary name or alias of an operating system. Case-insensitive.

Returns:

a member of the enum or null if not recognized.

Throws:

IllegalArgumentException - if name is blank.

fromOrUnknown

static OperatingSystem fromOrUnknown(String name)

Same as from(java.lang.String) but returns OperatingSystems.UNKNOWN instead of throwing an exception if the name isn't recognized.

Parameters:

name - primary name or alias of the well known operating system.

from

static OperatingSystem from(String name)

Looks up an operating system in the OperatingSystems.ALIAS_MAP or throws UnrecognizedAliasException.

Parameters:

name - primary name or alias of the well known operating system. Case-insensitive.

Returns:

the operating system entry.

Throws:

IllegalArgumentException - if name is blank.

UnrecognizedAliasException - if name isn't a known operating system name or alias (compared case insensitively).