Module org.spongepowered.plugin.metadata.mcmodinfo

Package org.spongepowered.plugin.meta

Class PluginDependency

java.lang.Object

org.spongepowered.plugin.meta.PluginDependency

public final class PluginDependency
extends Object

Represents a dependency on another plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PluginDependency.LoadOrder	Defines when the dependency should be loaded in relation to the plugin.

Constructor Summary

Constructors

Constructor	Description
PluginDependency(PluginDependency.LoadOrder loadOrder, String id, @Nullable String version, boolean optional)	Constructs a new PluginDependency with the given plugin ID and version range.

Method Summary

Modifier and Type	Method	Description
PluginDependency	asOptional()	Returns a new PluginDependency that has optional() set to true.
PluginDependency	asRequired()	Returns a new PluginDependency that has optional() set to false.
boolean	equals(@Nullable Object other)
int	hashCode()
String	id()	Returns the plugin ID of this PluginDependency.
PluginDependency.LoadOrder	loadOrder()	Returns the order to load the dependency in relation to the plugin.
boolean	optional()	Returns whether the dependency is optional for the plugin to work correctly.
String	toString()
@Nullable String	version()	Returns the version range this PluginDependency should match.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PluginDependency

public PluginDependency(PluginDependency.LoadOrder loadOrder,
 String id,
 @Nullable String version,
 boolean optional)

Constructs a new PluginDependency with the given plugin ID and version range.

Parameters:

loadOrder - The order to load the dependency in relation to the plugin

id - The plugin ID of the dependency

version - The version range of the dependency or null

optional - Whether the dependency is optional

Throws:

IllegalArgumentException - If the plugin ID is empty

See Also:

• Version range syntax

Method Details

loadOrder

public PluginDependency.LoadOrder loadOrder()

Returns the order to load the dependency in relation to the plugin.

Returns:

The load order

id

public String id()

Returns the plugin ID of this PluginDependency.

Returns:

The plugin ID

version

public @Nullable String version()

Returns the version range this PluginDependency should match.

The version range should use the Maven version range syntax:

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 version range, or null if unspecified

See Also:

• Maven version range specification
• Maven version design document

optional

public boolean optional()

Returns whether the dependency is optional for the plugin to work correctly.

Returns:

True if the dependency is optional

asOptional

public PluginDependency asOptional()

Returns a new PluginDependency that has optional() set to true.

Returns:

The new optional dependency

asRequired

public PluginDependency asRequired()

Returns a new PluginDependency that has optional() set to false.

Returns:

The new required dependency

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object