BootstrapContext (Box 6.0.0-SNAPSHOT)

public interface BootstrapContext

An interface that represents the context during Box initialization.

This context is only available before BoxAPI is initialized.

Method Summary

Modifier and Type

Method

Description

@NotNull BootstrapContext

addFeature(@NotNull FeatureFactory factory)

Adds a FeatureFactory to create and register BoxFeature.

static @NotNull BootstrapContext

get()

Gets the BootstrapContext.

@NotNull Path

getDataDirectory()

Gets the data directory of Box.

@NotNull DefaultMessageCollector

getDefaultMessageCollector()

Gets the DefaultMessageCollector.

@NotNull EventCaller<BoxEvent>

getEventCaller()

Gets the EventCaller.

@NotNull ListenerSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority>

getListenerSubscriber()

Gets the ListenerSubscriber.

@NotNull String

getVersion()

Gets the version of Box.

Method Details
- get
  
  @NotNull static @NotNull BootstrapContext get()
  
  Gets the BootstrapContext.
  
  Returns:
  
  the BootstrapContext
  
  Throws:
  
  IllegalStateException - if Box is not being initialized
- getDataDirectory
  
  @NotNull @NotNull Path getDataDirectory()
  
  Gets the data directory of Box.
  
  Returns:
  
  the data directory of Box
- getVersion
  
  @NotNull @NotNull String getVersion()
  
  Gets the version of Box.
  
  Returns:
  
  the version of Box
- getEventCaller
  
  @NotNull @NotNull EventCaller<BoxEvent> getEventCaller()
  
  Gets the EventCaller.
  
  Returns:
  
  the EventCaller
- getListenerSubscriber
  
  @NotNull @NotNull ListenerSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority> getListenerSubscriber()
  
  Gets the ListenerSubscriber.
  
  Returns:
  
  the ListenerSubscriber
- getDefaultMessageCollector
  
  @NotNull @NotNull DefaultMessageCollector getDefaultMessageCollector()
  
  Gets the DefaultMessageCollector.
  
  Returns:
  
  the DefaultMessageCollector
- addFeature
  
  @Contract("_ -> this") @NotNull @NotNull BootstrapContext addFeature(@NotNull @NotNull FeatureFactory factory)
  
  Adds a FeatureFactory to create and register BoxFeature.
  
  Parameters:
  
  factory - a FeatureFactory to create and register BoxFeature
  
  Returns:
  
  this BootstrapContext