org.hotswap.agent.annotation

Annotation Type Plugin

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

Plugin definition.

Author:

Jiri Bubnik

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	testedVersions Version of target framework this framework was tested with.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Any meaningful plugin description.
String[]	expectedVersions Version of target framework this framework should work with.
boolean	fallback If no other plugin matches and fallback is set to true, then use this plugin
String	group Plugin group the plugin belongs to.
String	name A name of the plugin.
Class<?>[]	supportClass Split plugin definition into multiple class files.

Element Detail

testedVersions

public abstract String[] testedVersions

Version of target framework this framework was tested with.

name

public abstract String name

A name of the plugin. This name is used to reference the plugin in code and configuration. It should not contain any spaces and weird characters.

Returns:

A name of the plugin

Default:

""

description

public abstract String description

Any meaningful plugin description.

Default:

""

group

public abstract String group

Plugin group the plugin belongs to. Group is used to resolve fallback plugin

Returns:

the string

Default:

""

fallback

public abstract boolean fallback

If no other plugin matches and fallback is set to true, then use this plugin

Returns:

Default:

false

expectedVersions

public abstract String[] expectedVersions

Version of target framework this framework should work with. It is not possible to test every possible framework version for all plugins. Because the plugin is usually hooked to a stable framework structure, it should for all subversions of a major version. Indicate with this property expected versions.

Default:

{}

supportClass

public abstract Class<?>[] supportClass

Split plugin definition into multiple class files. Annotations @OnClassLoadEvent and @OnResourceFileEvent will be scanned on supporting class in addition to pluginClass itself.

Default:

{}