me.lucko.helper.plugin.ap

Annotation Type Plugin

@Documented
 @Target(value=TYPE)
 @Retention(value=SOURCE)
public @interface Plugin

Annotation to automatically generate plugin.yml files for helper projects

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the plugin

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	apiVersion The api version of the plugin
String[]	authors The authors of the plugin
PluginDependency[]	depends A list of dependencies for the plugin
String	description A description of the plugin
String[]	hardDepends A list of hard dependencies for the plugin
PluginLoadOrder	load The load order of the plugin
String[]	loadBefore A list of plugins which should be loaded before this plugin
String[]	softDepends A list of soft dependencies for the plugin
String	version The plugin version
String	website A website for the plugin

Element Detail

name

@Nonnull
public abstract String name

The name of the plugin

Returns:

the name of the plugin

version

@Nonnull
public abstract String version

The plugin version

Returns:

the plugin version

Default:

""

description

@Nonnull
public abstract String description

A description of the plugin

Returns:

a description of the plugin

Default:

""

load

@Nonnull
public abstract PluginLoadOrder load

The load order of the plugin

Returns:

the load order of the plugin

Default:

org.bukkit.plugin.PluginLoadOrder.POSTWORLD

apiVersion

public abstract String apiVersion

The api version of the plugin

Returns:

the api version of the plugin

Default:

""

authors

@Nonnull
public abstract String[] authors

The authors of the plugin

Returns:

the author of the plugin

Default:

{}

website

@Nonnull
public abstract String website

A website for the plugin

Returns:

a website for the plugin

Default:

""

depends

@Nonnull
public abstract PluginDependency[] depends

A list of dependencies for the plugin

Returns:

a list of dependencies for the plugin

Default:

{}

hardDepends

@Nonnull
public abstract String[] hardDepends

A list of hard dependencies for the plugin

Returns:

a list of hard dependencies for the plugin

Default:

{}

softDepends

@Nonnull
public abstract String[] softDepends

A list of soft dependencies for the plugin

Returns:

a list of soft dependencies for the plugin

Default:

{}

loadBefore

@Nonnull
public abstract String[] loadBefore

A list of plugins which should be loaded before this plugin

Returns:

a list of plugins which should be loaded before this plugin

Default:

{}