java.lang.Object

net.neoforged.testframework.impl.TestFrameworkImpl

All Implemented Interfaces:: MutableTestFramework, TestFramework

@Internal @ParametersAreNonnullByDefault public class TestFrameworkImpl extends Object implements MutableTestFramework

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

final class

TestFrameworkImpl.TestsImpl

Nested classes/interfaces inherited from interface net.neoforged.testframework.impl.MutableTestFramework
MutableTestFramework.MutableTests

Nested classes/interfaces inherited from interface net.neoforged.testframework.TestFramework
TestFramework.Tests
Field Summary

Fields

Modifier and Type

Field

Description

private final @Nullable FrameworkClient

client

private String

commandName

private final FrameworkConfiguration

configuration

private net.neoforged.fml.ModContainer

container

(package private) static final Set<TestFrameworkImpl>

FRAMEWORKS

private final ResourceLocation

id

private static final DateTimeFormatter

LOG_FORMAT

private final org.slf4j.Logger

logger

private net.neoforged.bus.api.IEventBus

modBus

private @Nullable MinecraftServer

server

private final DynamicStructureTemplates

structures

private final SummaryDumper

summaryDumper

private final TestFrameworkImpl.TestsImpl

tests

Fields inherited from interface net.neoforged.testframework.impl.MutableTestFramework
REFERENCE_CODEC
Constructor Summary

Constructors

Constructor

Description

TestFrameworkImpl(FrameworkConfiguration configuration)
Method Summary

Modifier and Type

Method

Description

static String

capitaliseWords(String string, String splitOn)

void

changeStatus(Test test, Test.Status newStatus, @Nullable Entity changer)

Changes the status of a test.

List<Test>

collectTests(net.neoforged.fml.ModContainer container)

String

commandName()

FrameworkConfiguration

configuration()

net.neoforged.fml.ModContainer

container()

Returns the mod container bus linked to this framework.

DynamicStructureTemplates

dynamicStructures()

Returns a registrar for in-code structure templates.

ResourceLocation

id()

Returns the ID of this framework instance.

void

init(net.neoforged.bus.api.IEventBus modBus, net.neoforged.fml.ModContainer container)

org.slf4j.Logger

logger()

Returns this framework's logger.

net.neoforged.bus.api.IEventBus

modEventBus()

Returns the mod event bus linked to this framework.

PlayerTestStore

playerTestStore()

void

registerCommands(com.mojang.brigadier.builder.LiteralArgumentBuilder<CommandSourceStack> node)

private void

sendPacketIfOn(@Nullable Runnable onServer, @Nullable Runnable remoteClient, @Nullable Runnable singlePlayer)

void

setEnabled(Test test, boolean enabled, @Nullable Entity changer)

Enables or disables a test.

private static void

setupClient(TestFrameworkImpl impl, net.neoforged.bus.api.IEventBus modBus, net.neoforged.fml.ModContainer container)

TestFrameworkImpl.TestsImpl

tests()

Returns the Tests instance of this framework.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.testframework.impl.MutableTestFramework
buildCommand, disableCommand, enableCommand, setStatusCommand

Field Details
- FRAMEWORKS
  
  static final Set<TestFrameworkImpl> FRAMEWORKS
- LOG_FORMAT
  
  private static final DateTimeFormatter LOG_FORMAT
- configuration
  
  private final FrameworkConfiguration configuration
- client
  
  @Nullable private final @Nullable FrameworkClient client
- logger
  
  private final org.slf4j.Logger logger
- id
  
  private final ResourceLocation id
- tests
  
  private final TestFrameworkImpl.TestsImpl tests
- server
  
  @Nullable private @Nullable MinecraftServer server
- structures
  
  private final DynamicStructureTemplates structures
- summaryDumper
  
  private final SummaryDumper summaryDumper
- commandName
  
  private String commandName
- modBus
  
  private net.neoforged.bus.api.IEventBus modBus
- container
  
  private net.neoforged.fml.ModContainer container
Constructor Details
- TestFrameworkImpl
  
  public TestFrameworkImpl(FrameworkConfiguration configuration)
Method Details
- registerCommands
  
  public void registerCommands(com.mojang.brigadier.builder.LiteralArgumentBuilder<CommandSourceStack> node)
  
  Specified by:
  
  registerCommands in interface MutableTestFramework
- playerTestStore
  
  public PlayerTestStore playerTestStore()
  
  Specified by:
  
  playerTestStore in interface MutableTestFramework
- dynamicStructures
  
  public DynamicStructureTemplates dynamicStructures()
  
  Description copied from interface: TestFramework
  
  Returns a registrar for in-code structure templates.
  
  Specified by:
  
  dynamicStructures in interface TestFramework
  
  Returns:
  
  a registrar for in-code structure templates
- commandName
  
  public String commandName()
  
  Specified by:
  
  commandName in interface MutableTestFramework
- configuration
  
  public FrameworkConfiguration configuration()
  
  Specified by:
  
  configuration in interface MutableTestFramework
- init
  
  public void init(net.neoforged.bus.api.IEventBus modBus, net.neoforged.fml.ModContainer container)
  
  Specified by:
  
  init in interface MutableTestFramework
- setupClient
  
  private static void setupClient(TestFrameworkImpl impl, net.neoforged.bus.api.IEventBus modBus, net.neoforged.fml.ModContainer container)
- collectTests
  
  public List<Test> collectTests(net.neoforged.fml.ModContainer container)
  
  Specified by:
  
  collectTests in interface MutableTestFramework
- modEventBus
  
  public net.neoforged.bus.api.IEventBus modEventBus()
  
  Description copied from interface: TestFramework
  
  Returns the mod event bus linked to this framework.
  
  Specified by:
  
  modEventBus in interface TestFramework
  
  Returns:
  
  the mod event bus linked to this framework
- container
  
  public net.neoforged.fml.ModContainer container()
  
  Description copied from interface: TestFramework
  
  Returns the mod container bus linked to this framework.
  
  Specified by:
  
  container in interface TestFramework
  
  Returns:
  
  the mod container bus linked to this framework
- id
  
  public ResourceLocation id()
  
  Description copied from interface: TestFramework
  
  Returns the ID of this framework instance.
  
  Specified by:
  
  id in interface TestFramework
  
  Returns:
  
  the ID of this framework instance
- logger
  
  public org.slf4j.Logger logger()
  
  Description copied from interface: TestFramework
  
  Returns this framework's logger.
  
  Specified by:
  
  logger in interface TestFramework
  
  Returns:
  
  this framework's logger
- tests
  
  public TestFrameworkImpl.TestsImpl tests()
  
  Description copied from interface: TestFramework
  
  Returns the Tests instance of this framework.
  
  Specified by:
  
  tests in interface MutableTestFramework
  
  Specified by:
  
  tests in interface TestFramework
  
  Returns:
  
  the Tests instance of this framework
- changeStatus
  
  public void changeStatus(Test test, Test.Status newStatus, @Nullable @Nullable Entity changer)
  
  Description copied from interface: TestFramework
  
  Changes the status of a test.
  
  Specified by:
  
  changeStatus in interface TestFramework
  
  Parameters:
  
  test - the test whose status to change
  
  newStatus - the status to change to
  
  changer - the entity that changed the status of the test. Usually the player completing a test
- setEnabled
  
  public void setEnabled(Test test, boolean enabled, @Nullable @Nullable Entity changer)
  
  Description copied from interface: TestFramework
  
  Enables or disables a test.
  
  Specified by:
  
  setEnabled in interface TestFramework
  
  Parameters:
  
  test - the test to enable/disable
  
  enabled - true if to enable, false if to disable
  
  changer - the entity that changed the status of the test. Usually the player which runs the enable command
- sendPacketIfOn
  
  private void sendPacketIfOn(@Nullable @Nullable Runnable onServer, @Nullable @Nullable Runnable remoteClient, @Nullable @Nullable Runnable singlePlayer)
- capitaliseWords
  
  public static String capitaliseWords(String string, String splitOn)

Class TestFrameworkImpl

Nested Class Summary

Nested classes/interfaces inherited from interface net.neoforged.testframework.impl.MutableTestFramework

Nested classes/interfaces inherited from interface net.neoforged.testframework.TestFramework

Field Summary

Fields inherited from interface net.neoforged.testframework.impl.MutableTestFramework

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.neoforged.testframework.impl.MutableTestFramework

Field Details

FRAMEWORKS

LOG_FORMAT

configuration

client

logger

id

tests

server

structures

summaryDumper

commandName

modBus

container

Constructor Details

TestFrameworkImpl

Method Details

registerCommands

playerTestStore

dynamicStructures

commandName

configuration

init

setupClient

collectTests

modEventBus

container

id

logger

tests

changeStatus

setEnabled

sendPacketIfOn

capitaliseWords