Package com.jozufozu.flywheel.util

Enum Class Mods

java.lang.Object

java.lang.Enum<Mods>

com.jozufozu.flywheel.util.Mods

All Implemented Interfaces:

Serializable, Comparable<Mods>, Constable

public enum Mods
extends Enum<Mods>

For compatibility with and without another mod present, we have to define load conditions of the specific code

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
STARLIGHT

Method Summary

Modifier and Type	Method	Description
void	executeIfInstalled(Supplier<Runnable> toExecute)	Simple hook to execute code if a mod is installed
boolean	isLoaded()
<T> Optional<T>	runIfInstalled(Supplier<Supplier<T>> toRun)	Simple hook to run code if a mod is installed
static Mods	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Mods[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STARLIGHT

public static final Mods STARLIGHT

Method Details

values

public static Mods[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Mods valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isLoaded

public boolean isLoaded()

Returns:

a boolean of whether the mod is loaded or not based on mod id

runIfInstalled

public <T> Optional<T> runIfInstalled(Supplier<Supplier<T>> toRun)

Simple hook to run code if a mod is installed

Parameters:

toRun - will be run only if the mod is loaded

Returns:

Optional.empty() if the mod is not loaded, otherwise an Optional of the return value of the given supplier

executeIfInstalled

public void executeIfInstalled(Supplier<Runnable> toExecute)

Simple hook to execute code if a mod is installed

Parameters:

toExecute - will be executed only if the mod is loaded