Package net.neoforged.testframework.impl

Class TestFrameworkImpl.TestsImpl

java.lang.Object

net.neoforged.testframework.impl.TestFrameworkImpl.TestsImpl

All Implemented Interfaces:

MutableTestFramework.MutableTests, TestFramework.Tests

Enclosing class:

TestFrameworkImpl

@ParametersAreNonnullByDefault
public final class TestFrameworkImpl.TestsImpl
extends Object
implements MutableTestFramework.MutableTests

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<Test>	allView
private Map<net.neoforged.fml.common.EventBusSubscriber.Bus,net.neoforged.bus.api.IEventBus>	buses
private final Map<String,EventListenerGroupImpl>	collectors
private final Set<String>	enabled
private final Set<TestListener>	globalListeners
private final Map<String,Group>	groups
private final Map<String,Test.Status>	statuses
private final Map<String,Test>	tests

Constructor Summary

Constructors

Constructor	Description
TestsImpl()

Method Summary

Modifier and Type	Method	Description
private Group	addGroupToParents(Group group)
void	addListener(TestListener listener)	Adds a global test listener.
Collection<Test>	all()	Returns an unmodifiable view of all the tests registered this this instance.
Collection<Group>	allGroups()	Returns all the registered test groups.
Optional<Test>	byId(String id)	Queries a test by its ID.
void	disable(String id)	Disables a test.
void	enable(String id)	Enables a test.
Stream<Test>	enabled()
Group	getOrCreateGroup(String id)	Gets or creates a test group.
Test.Status	getStatus(String testId)
void	initialiseDefaultEnabledTests()
boolean	isEnabled(String id)	Checks if a test is enabled.
Optional<Group>	maybeGetGroup(String id)
void	register(Test test)	Registers a test to the framework.
void	setStatus(String testId, Test.Status status)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

tests

private final Map<String,Test> tests

groups

private final Map<String,Group> groups

collectors

private final Map<String,EventListenerGroupImpl> collectors

enabled

private final Set<String> enabled

statuses

private final Map<String,Test.Status> statuses

buses

private Map<net.neoforged.fml.common.EventBusSubscriber.Bus,net.neoforged.bus.api.IEventBus> buses

globalListeners

private final Set<TestListener> globalListeners

allView

private final Collection<Test> allView

Constructor Details

TestsImpl

public TestsImpl()

Method Details

addListener

public void addListener(TestListener listener)

Description copied from interface: TestFramework.Tests

Adds a global test listener.

Specified by:

addListener in interface TestFramework.Tests

Parameters:

listener - the listener

byId

public Optional<Test> byId(String id)

Description copied from interface: TestFramework.Tests

Queries a test by its ID.

Specified by:

byId in interface TestFramework.Tests

Parameters:

id - the ID of the test to query

Returns:

the test, if present

getOrCreateGroup

public Group getOrCreateGroup(String id)

Description copied from interface: TestFramework.Tests

Gets or creates a test group.

Specified by:

getOrCreateGroup in interface TestFramework.Tests

Parameters:

id - the ID of the group

Returns:

the old group, if one existed, or the new one if a group with that ID did not exist before.

maybeGetGroup

public Optional<Group> maybeGetGroup(String id)

Specified by:

maybeGetGroup in interface MutableTestFramework.MutableTests

allGroups

public Collection<Group> allGroups()

Description copied from interface: TestFramework.Tests

Returns all the registered test groups.

Specified by:

allGroups in interface TestFramework.Tests

Returns:

all the registered test groups

enable

public void enable(String id)

Description copied from interface: TestFramework.Tests

Enables a test.

This method only updates the local test.
It will not update clients or the server.
Prefer using TestFramework.setEnabled(Test, boolean, Entity) instead.

Specified by:

enable in interface TestFramework.Tests

Parameters:

id - the ID of the test to enable

disable

public void disable(String id)

Description copied from interface: TestFramework.Tests

Disables a test.

This method only updates the local test.
It will not update clients or the server.
Prefer using TestFramework.setEnabled(Test, boolean, Entity) instead.

Specified by:

disable in interface TestFramework.Tests

Parameters:

id - the ID of the test to disable

isEnabled

public boolean isEnabled(String id)

Description copied from interface: TestFramework.Tests

Checks if a test is enabled.

Specified by:

isEnabled in interface TestFramework.Tests

Parameters:

id - the ID of the test to check

Returns:

if the test is enabled

getStatus

public Test.Status getStatus(String testId)

Specified by:

getStatus in interface TestFramework.Tests

setStatus

public void setStatus(String testId,
 Test.Status status)

Specified by:

setStatus in interface MutableTestFramework.MutableTests

register

public void register(Test test)

Description copied from interface: TestFramework.Tests

Registers a test to the framework.
It is recommended you register tests during mod loading, for proper indexing.

Specified by:

register in interface TestFramework.Tests

Parameters:

test - the test to register

addGroupToParents

private Group addGroupToParents(Group group)

all

public Collection<Test> all()

Description copied from interface: TestFramework.Tests

Returns an unmodifiable view of all the tests registered this this instance.

Specified by:

all in interface TestFramework.Tests

Returns:

an unmodifiable view of all the tests registered this this instance

enabled

public Stream<Test> enabled()

Specified by:

enabled in interface MutableTestFramework.MutableTests

initialiseDefaultEnabledTests

public void initialiseDefaultEnabledTests()

Specified by:

initialiseDefaultEnabledTests in interface MutableTestFramework.MutableTests