Package org.skriptlang.skript.lang.experiment

Enum Class LifeCycle

java.lang.Object

java.lang.Enum<LifeCycle>

org.skriptlang.skript.lang.experiment.LifeCycle

All Implemented Interfaces:

Serializable, Comparable<LifeCycle>, Constable

public enum LifeCycle
extends Enum<LifeCycle>

The life cycle phase of an Experiment.

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
DEPRECATED	A feature at the end of its life cycle, being prepared for removal.
EXPERIMENTAL	An experimental, preview feature designed to be used with caution.
MAINSTREAM	Represents a feature that was previously opt-in (or experimental) but is now a part of the default set.
STABLE	A feature that is expected to be safe and (at least) semi-permanent.
UNKNOWN	Represents an unregistered, unknown feature.

Method Summary

Modifier and Type	Method	Description
static LifeCycle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LifeCycle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
boolean	warn()

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

STABLE

public static final LifeCycle STABLE

A feature that is expected to be safe and (at least) semi-permanent. This can be used for long-term features that are kept behind toggles to prevent breaking changes.

EXPERIMENTAL

public static final LifeCycle EXPERIMENTAL

An experimental, preview feature designed to be used with caution. Features in the experimental phase may be subject to changes or removal at short notice.

DEPRECATED

public static final LifeCycle DEPRECATED

A feature at the end of its life cycle, being prepared for removal. Scripts will report a deprecation warning on load if a deprecated feature is used.

MAINSTREAM

public static final LifeCycle MAINSTREAM

Represents a feature that was previously opt-in (or experimental) but is now a part of the default set. I.e. it no longer needs to be enabled using a feature flag. This will provide a little note to the user on load informing them they no longer need to use this feature flag.

UNKNOWN

public static final LifeCycle UNKNOWN

Represents an unregistered, unknown feature. This occurs when a user tags a script as using X, where X is not a registered feature provided by any addon or extension. Scripts will report a warning on load if an unknown feature is used, but this will not prevent the loading cycle.

Method Details

values

public static LifeCycle[] 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 LifeCycle 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

warn

public boolean warn()

Returns:

Whether using a feature of this type will produce a warning on load.