Package xyz.janboerman.scalaloader.plugin

Class ScalaPluginDescription

java.lang.Object

xyz.janboerman.scalaloader.plugin.ScalaPluginDescription

public class ScalaPluginDescription
extends Object

The Java API for configuring a ScalaPlugin. This API is meant as a compile-time type-safe alternative to the error-prone plugin.yml files. An instance of this class is used by ScalaPlugin(ScalaPluginDescription).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScalaPluginDescription.Command
static class	ScalaPluginDescription.Permission

Constructor Summary

Constructors

Constructor	Description
ScalaPluginDescription(String pluginName, String pluginVersion)

Method Summary

Modifier and Type	Method	Description
ScalaPluginDescription	addAuthor(String author)
ScalaPluginDescription	addCommand(ScalaPluginDescription.Command command)
ScalaPluginDescription	addContributor(String contributor)
ScalaPluginDescription	addHardDepend(String dependency)
ScalaPluginDescription	addLoadBefore(String inverseDependency)
ScalaPluginDescription	addMavenDependency(String mavenDependency)	Adds a maven dependency to the ScalaPlugin.
ScalaPluginDescription	addPermission(ScalaPluginDescription.Permission permission)
ScalaPluginDescription	addProvides(String pluginApi)
ScalaPluginDescription	addSoftDepend(String dependency)
void	addYaml(Map<String,Object> yaml)	Deprecated. internal use only
ScalaPluginDescription	authors(String... authors)
ScalaPluginDescription	bootstrapper(Class<?> bootstrapperClass)	Set's the ScalaPlugin's bootstrapper.
ScalaPluginDescription	bootstrapper(String bootstrapperClassName)
ScalaPluginDescription	commands(ScalaPluginDescription.Command... commands)
ScalaPluginDescription	contributors(String... contributors)
ScalaPluginDescription	description(String pluginDescription)
ScalaPluginDescription	foliaSupported()
String	getApiVersion()
List<String>	getAuthors()
Class<?>	getBootstrapper()
String	getBootstrapperName()
Collection<ScalaPluginDescription.Command>	getCommands()
Collection<String>	getContributors()
String	getDescription()
String	getFullName()
Set<String>	getHardDependencies()
Set<String>	getInverseDependencies()
PluginLoadOrder	getLoadOrder()
String	getMain()	Deprecated. internal use only
Set<String>	getMavenDependencies()
String	getName()
PermissionDefault	getPermissionDefault()
Collection<ScalaPluginDescription.Permission>	getPermissions()
String	getPrefix()
Set<String>	getProvides()
String	getScalaVersion()	Deprecated. internal use only
Set<String>	getSoftDependencies()
String	getVersion()
String	getWebsite()
ScalaPluginDescription	hardDepend(String... dependencies)
boolean	hasOpenClassLoader()
boolean	isFoliaSupported()
ScalaPluginDescription	loadBefore(String... inverseDependencies)
ScalaPluginDescription	loadOrder(PluginLoadOrder loadOrder)
ScalaPluginDescription	mavenDependencies(String... mavenDependencies)	Sets the maven dependencies of the ScalaPlugin.
ScalaPluginDescription	moveHardDependencyToSoftDependency(String dependency)
ScalaPluginDescription	openClassLoader(boolean openClassLoader)
ScalaPluginDescription	permissionDefault(PermissionDefault permissionDefault)
ScalaPluginDescription	permissions(ScalaPluginDescription.Permission... permissions)
ScalaPluginDescription	prefix(String prefix)
ScalaPluginDescription	provides(String... pluginApis)
void	readFromPluginYamlData(Map<String,Object> pluginYaml)
void	setApiVersion(String bukkitApiVersion)	Deprecated. internal use only
ScalaPluginDescription	setFoliaSupported(boolean supportFolia)
void	setMain(String mainClass)	Deprecated. internal use only
void	setScalaVersion(String scalaVersion)	Deprecated. internal use only
ScalaPluginDescription	softDepend(String... dependencies)
PluginDescriptionFile	toPluginDescriptionFile()
ScalaPluginDescription	website(String website)

Methods inherited from class java.lang.Object

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

Constructor Details

ScalaPluginDescription

public ScalaPluginDescription(String pluginName,
 String pluginVersion)

Method Details

setApiVersion

@Deprecated
public void setApiVersion(String bukkitApiVersion)

Deprecated.

internal use only

setMain

@Deprecated
public void setMain(String mainClass)

Deprecated.

internal use only

addYaml

@Deprecated
public void addYaml(Map<String,Object> yaml)

Deprecated.

internal use only

setScalaVersion

@Deprecated
public void setScalaVersion(String scalaVersion)

Deprecated.

internal use only

getScalaVersion

@Deprecated
public String getScalaVersion()

Deprecated.

internal use only

foliaSupported

public ScalaPluginDescription foliaSupported()

setFoliaSupported

public ScalaPluginDescription setFoliaSupported(boolean supportFolia)

isFoliaSupported

public boolean isFoliaSupported()

getMain

@Deprecated
public String getMain()

Deprecated.

internal use only

getName

public String getName()

getVersion

public String getVersion()

getFullName

public String getFullName()

description

public ScalaPluginDescription description(String pluginDescription)

getDescription

public String getDescription()

authors

public ScalaPluginDescription authors(String... authors)

addAuthor

public ScalaPluginDescription addAuthor(String author)

getAuthors

public List<String> getAuthors()

contributors

public ScalaPluginDescription contributors(String... contributors)

addContributor

public ScalaPluginDescription addContributor(String contributor)

getContributors

public Collection<String> getContributors()

loadOrder

public ScalaPluginDescription loadOrder(PluginLoadOrder loadOrder)

getLoadOrder

public PluginLoadOrder getLoadOrder()

website

public ScalaPluginDescription website(String website)

getWebsite

public String getWebsite()

prefix

public ScalaPluginDescription prefix(String prefix)

getPrefix

public String getPrefix()

getApiVersion

public String getApiVersion()

hardDepend

public ScalaPluginDescription hardDepend(String... dependencies)

addHardDepend

public ScalaPluginDescription addHardDepend(String dependency)

getHardDependencies

public Set<String> getHardDependencies()

moveHardDependencyToSoftDependency

public ScalaPluginDescription moveHardDependencyToSoftDependency(String dependency)

softDepend

public ScalaPluginDescription softDepend(String... dependencies)

addSoftDepend

public ScalaPluginDescription addSoftDepend(String dependency)

getSoftDependencies

public Set<String> getSoftDependencies()

loadBefore

public ScalaPluginDescription loadBefore(String... inverseDependencies)

addLoadBefore

public ScalaPluginDescription addLoadBefore(String inverseDependency)

getInverseDependencies

public Set<String> getInverseDependencies()

provides

public ScalaPluginDescription provides(String... pluginApis)

addProvides

public ScalaPluginDescription addProvides(String pluginApi)

getProvides

public Set<String> getProvides()

mavenDependencies

public ScalaPluginDescription mavenDependencies(String... mavenDependencies)

Sets the maven dependencies of the ScalaPlugin. This method only supports maven dependencies available on Maven Central.

Parameters:

mavenDependencies - the dependencies in GAV format, e.g. "com.example.foo:foo:1.0"

Returns:

this ScalaPluginDescription

addMavenDependency

public ScalaPluginDescription addMavenDependency(String mavenDependency)

Adds a maven dependency to the ScalaPlugin. This method only supports maven dependencies available on Maven Central.

Parameters:

mavenDependency - the dependency in GAV format, e.g. "com.example.foo:foo:1.0"

Returns:

this ScalaPluginDescription

getMavenDependencies

public Set<String> getMavenDependencies()

permissionDefault

public ScalaPluginDescription permissionDefault(PermissionDefault permissionDefault)

getPermissionDefault

public PermissionDefault getPermissionDefault()

commands

public ScalaPluginDescription commands(ScalaPluginDescription.Command... commands)

addCommand

public ScalaPluginDescription addCommand(ScalaPluginDescription.Command command)

getCommands

public Collection<ScalaPluginDescription.Command> getCommands()

permissions

public ScalaPluginDescription permissions(ScalaPluginDescription.Permission... permissions)

addPermission

public ScalaPluginDescription addPermission(ScalaPluginDescription.Permission permission)

getPermissions

public Collection<ScalaPluginDescription.Permission> getPermissions()

bootstrapper

public ScalaPluginDescription bootstrapper(String bootstrapperClassName)

bootstrapper

public ScalaPluginDescription bootstrapper(Class<?> bootstrapperClass)

Set's the ScalaPlugin's bootstrapper. When running your ScalaPlugin on the Paper server software, this class will be used to boostrap your plugin.

Parameters:

bootstrapperClass - the bootstrap class. This class must implement io.papermc.paper.plugin.bootstrap.PluginBootstrap.

Returns:

this ScalaPluginDescription

See Also:

• Paper Plugins documentation on PaperMC.io

getBootstrapper

public Class<?> getBootstrapper()

getBootstrapperName

public String getBootstrapperName()

hasOpenClassLoader

public boolean hasOpenClassLoader()

openClassLoader

public ScalaPluginDescription openClassLoader(boolean openClassLoader)

toPluginDescriptionFile

public PluginDescriptionFile toPluginDescriptionFile()

readFromPluginYamlData

public void readFromPluginYamlData(Map<String,Object> pluginYaml)