Package net.neoforged.testframework.conf

Enum Class Feature

java.lang.Object

java.lang.Enum<Feature>

net.neoforged.testframework.conf.Feature

All Implemented Interfaces:

Serializable, Comparable<Feature>, Constable

public enum Feature
extends Enum<Feature>

This class represents the different features a TestFramework may have.

See Also:

• FrameworkConfiguration.Builder.enable(Feature...)
• FrameworkConfiguration.Builder.disable(Feature...)

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
CLIENT_MODIFICATIONS	This feature allows clients to modify the status of tests.
CLIENT_SYNC	This feature syncs the status of tests to clients.
GAMETEST	This feature enables the GameTest integration.
MAGIC_ANNOTATIONS	Register tests with annotations.
SUMMARY_DUMP	When enabled, test summaries will be dumped when a server stops.
TEST_STORE	When enabled, this feature will store the tests that existed when a player last logged on, using a SavedData.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	enabledByDefault

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Feature(boolean enabledByDefault)

Method Summary

Modifier and Type	Method	Description
boolean	isEnabledByDefault()
static Feature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Feature[]	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

CLIENT_SYNC

public static final Feature CLIENT_SYNC

This feature syncs the status of tests to clients.

CLIENT_MODIFICATIONS

public static final Feature CLIENT_MODIFICATIONS

This feature allows clients to modify the status of tests.

GAMETEST

public static final Feature GAMETEST

This feature enables the GameTest integration.

SUMMARY_DUMP

public static final Feature SUMMARY_DUMP

When enabled, test summaries will be dumped when a server stops.

TEST_STORE

public static final Feature TEST_STORE

When enabled, this feature will store the tests that existed when a player last logged on, using a SavedData.
When a player joins, they will get a message in chat containing all newly added tests.

MAGIC_ANNOTATIONS

public static final Feature MAGIC_ANNOTATIONS

Register tests with annotations.

Field Details

enabledByDefault

private final boolean enabledByDefault

Constructor Details

Feature

private Feature(boolean enabledByDefault)

Method Details

values

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

isEnabledByDefault

public boolean isEnabledByDefault()