de.griefed.serverpackcreator.addons.configurationhandler

Interface ConfigCheckExtension

All Superinterfaces:

BaseInformation, ExtensionInformation, org.pf4j.ExtensionPoint

public interface ConfigCheckExtension
extends ExtensionInformation

Extension point for configuration checks, so you can run your own checks on a given ConfigurationModel should you so desire.

Method Summary

Modifier and Type

Method and Description

boolean

runCheck(@NotNull VersionMeta versionMeta, @NotNull ApplicationProperties applicationProperties, @NotNull Utilities utilities, @NotNull ConfigurationModel configurationModel, @NotNull java.util.List<java.lang.String> encounteredErrors, @NotNull java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig, @NotNull java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> packSpecificConfigs)

Methods inherited from interface de.griefed.serverpackcreator.addons.ExtensionInformation

getExtensionId

Methods inherited from interface de.griefed.serverpackcreator.addons.BaseInformation

getAuthor, getDescription, getName, getVersion

Method Detail

runCheck

boolean runCheck(@NotNull
                 @NotNull VersionMeta versionMeta,
                 @NotNull
                 @NotNull ApplicationProperties applicationProperties,
                 @NotNull
                 @NotNull Utilities utilities,
                 @NotNull
                 @NotNull ConfigurationModel configurationModel,
                 @NotNull
                 @NotNull java.util.List<java.lang.String> encounteredErrors,
                 @NotNull
                 @NotNull java.util.Optional<com.electronwill.nightconfig.core.CommentedConfig> addonConfig,
                 @NotNull
                 @NotNull java.util.ArrayList<com.electronwill.nightconfig.core.CommentedConfig> packSpecificConfigs)
          throws java.lang.Exception

Parameters:

versionMeta - Instance of VersionMeta so you can work with available Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.

applicationProperties - Instance of ApplicationProperties The current configuration of ServerPackCreator, like the default list of clientside-only mods, the server pack directory etc.

utilities - Instance of Utilities commonly used across ServerPackCreator.

configurationModel - The configuration to check.

encounteredErrors - A list of encountered errors during any and all checks. The list is displayed to the user if it contains any entries.

addonConfig - Configuration for this addon, conveniently provided by ServerPackCreator.

packSpecificConfigs - Modpack and server pack specific configurations for this addon, conveniently provided by ServerPackCreator.

Returns:

true if an error was encountered. false if the checks were successful.

Throws:

java.lang.Exception - if any unexpected error is encountered during the execution of this method.