de.griefed.serverpackcreator.addons

Class ServerPackCreatorAddon

java.lang.Object

org.pf4j.Plugin

de.griefed.serverpackcreator.addons.ServerPackCreatorAddon

All Implemented Interfaces:

BaseInformation

public abstract class ServerPackCreatorAddon
extends org.pf4j.Plugin
implements BaseInformation

A ServerPackCreator addon provides additional functionality to ServerPackCreator via any of

• ConfigCheckExtension
• PostGenExtension
• PreGenExtension
• PreZipExtension
• ConfigPanelExtension
• TabExtension

and

• ExtensionConfigPanel
• ExtensionTab

For details on pf4j, the library used to realize the addon-functionality in ServerPackCreator, visit pf4j.org

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	LOG_ADDONS

Fields inherited from class org.pf4j.Plugin

log, wrapper

Constructor Summary

Constructors

Constructor and Description
ServerPackCreatorAddon(@NotNull org.pf4j.PluginWrapper wrapper) Using the pre-made ServerPackCreatorAddon-class and extending it, you can save yourself the hassle of writing the code which provides ServerPackCreator with information about your addon.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.String	getAuthor() Get the author of this addon.
@NotNull java.lang.String	getDescription() Get the description of this addon.
@NotNull java.lang.String	getId()
@NotNull java.lang.String	getName() Get the name of this addon.
@NotNull java.lang.String	getVersion() Get the version of this addon.
void	start() This method is called by the application when the plugin is started.
void	stop() This method is called by the application when the plugin is stopped.

Methods inherited from class org.pf4j.Plugin

delete, getWrapper

Methods inherited from class java.lang.Object

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

Field Detail

LOG_ADDONS

protected static final org.apache.logging.log4j.Logger LOG_ADDONS

Constructor Detail

ServerPackCreatorAddon

public ServerPackCreatorAddon(@NotNull
                              @NotNull org.pf4j.PluginWrapper wrapper)
                       throws java.io.IOException

Using the pre-made ServerPackCreatorAddon-class and extending it, you can save yourself the hassle of writing the code which provides ServerPackCreator with information about your addon.

The only thing you need to take care of is your build.gradle and the Name,Description,Author and Version fields.

Parameters:

wrapper - PluginWrapper provided by ServerPackCreator. Do not touch unless you know what you are doing.

Throws:

java.io.IOException - if the addon could not be initialized.

Method Detail

start

public void start()
           throws org.pf4j.PluginRuntimeException

This method is called by the application when the plugin is started. See PluginManager.startPlugin(String).

If you intend on overwriting this method, make sure to call super.start() first.

Overrides:

start in class org.pf4j.Plugin

Throws:

org.pf4j.PluginRuntimeException - if something goes wrong.

stop

public void stop()
          throws org.pf4j.PluginRuntimeException

This method is called by the application when the plugin is stopped. See PluginManager.stopPlugin(String).

If you intend on overwriting this method, make sure to call super.start() first.

Overrides:

stop in class org.pf4j.Plugin

Throws:

org.pf4j.PluginRuntimeException - if something goes wrong.

getId

@NotNull
public @NotNull java.lang.String getId()

getName

@NotNull
public @NotNull java.lang.String getName()

Description copied from interface: BaseInformation

Get the name of this addon.

Specified by:

getName in interface BaseInformation

Returns:

The name of this addon.

getDescription

@NotNull
public @NotNull java.lang.String getDescription()

Description copied from interface: BaseInformation

Get the description of this addon.

Specified by:

getDescription in interface BaseInformation

Returns:

The description of this addon.

getAuthor

@NotNull
public @NotNull java.lang.String getAuthor()

Description copied from interface: BaseInformation

Get the author of this addon.

Specified by:

getAuthor in interface BaseInformation

Returns:

The author of this addon.

getVersion

@NotNull
public @NotNull java.lang.String getVersion()

Description copied from interface: BaseInformation

Get the version of this addon.

Specified by:

getVersion in interface BaseInformation

Returns:

The version of this addon.