org.spongepowered.api.plugin

Annotation Type Dependency

@Retention(value=RUNTIME)
 @Target(value={})
public @interface Dependency

Represents a dependency for a Plugin.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The plugin ID of the dependency.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	optional If this dependency is optional for the plugin to work.
String	version The required version range of the dependency.

Element Detail

id

public abstract String id

The plugin ID of the dependency.

Returns:

The dependency plugin ID

See Also:

Plugin.id()

version

public abstract String version

The required version range of the dependency.

The version range will be specified in Maven version range syntax:

Range	Meaning
1.0	Any dependency version, 1.0 is recommended
[1.0]	x == 1.0
[1.0,)	x >= 1.0
(1.0,)	x > 1.0
(,1.0]	x <= 1.0
(,1.0)	x < 1.0
(1.0,2.0)	1.0 < x < 2.0
[1.0,2.0]	1.0 <= x <= 2.0

Returns:

The required version range, or an empty string if unspecified

See Also:

Maven version range specification, Maven version design document

Default:

""

optional

public abstract boolean optional

If this dependency is optional for the plugin to work. By default this is false.

Returns:

True if the dependency is optional for the plugin to work

Default:

false