Module net.neoforged.bus

Package net.neoforged.bus

Class BusBuilderImpl

java.lang.Object

net.neoforged.bus.BusBuilderImpl

All Implemented Interfaces:

BusBuilder

@Internal
public final class BusBuilderImpl
extends Object
implements BusBuilder

BusBuilder Implementation, public for BusBuilder.builder() only, don't use this directly.

Constructor Summary

Constructors

Constructor	Description
BusBuilderImpl()

Method Summary

Modifier and Type	Method	Description
BusBuilder	allowPerPhasePost()	Allow calling IEventBus.post(EventPriority, Event).
IEventBus	build()	Returns a built bus configured according to the configuration of this builder.
BusBuilder	checkTypesOnDispatch()	Make the bus check posted events using the class checker.
BusBuilder	classChecker(IEventClassChecker checker)	Set a class checker that will allow validating the event types that the bus can handle.
BusBuilder	setExceptionHandler(IEventExceptionHandler handler)	Override the default exception handler.
BusBuilder	startShutdown()	Create the bus in a shut down state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.BusBuilder

markerType

Constructor Details

BusBuilderImpl

public BusBuilderImpl()

Method Details

setExceptionHandler

public BusBuilder setExceptionHandler(IEventExceptionHandler handler)

Description copied from interface: BusBuilder

Override the default exception handler.

Specified by:

setExceptionHandler in interface BusBuilder

Parameters:

handler - the custom exception handler to use

Returns:

the builder instance

startShutdown

public BusBuilder startShutdown()

Description copied from interface: BusBuilder

Create the bus in a shut down state.

This bus will not post events (and will instead silently ignore them) until it is started.

Specified by:

startShutdown in interface BusBuilder

Returns:

the builder instance

checkTypesOnDispatch

public BusBuilder checkTypesOnDispatch()

Description copied from interface: BusBuilder

Make the bus check posted events using the class checker.

Specified by:

checkTypesOnDispatch in interface BusBuilder

Returns:

the builder instance

classChecker

public BusBuilder classChecker(IEventClassChecker checker)

Description copied from interface: BusBuilder

Set a class checker that will allow validating the event types that the bus can handle.

Specified by:

classChecker in interface BusBuilder

Parameters:

checker - the custom checker

Returns:

the builder instance

allowPerPhasePost

public BusBuilder allowPerPhasePost()

Description copied from interface: BusBuilder

Allow calling IEventBus.post(EventPriority, Event).

Specified by:

allowPerPhasePost in interface BusBuilder

build

public IEventBus build()

Description copied from interface: BusBuilder

Returns a built bus configured according to the configuration of this builder.

Specified by:

build in interface BusBuilder

Returns:

a built bus configured according to the configuration of this builder