Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.model

Record Class PluginDependency

java.lang.Object

java.lang.Record

org.spongepowered.plugin.metadata.model.PluginDependency

Record Components:

id - The id

version - The version, as a maven range.

loadOrder - The load order

optional - Whether this dependency is optional

public record PluginDependency(String id, VersionRange version, PluginDependency.LoadOrder loadOrder, boolean optional)
extends Record

Specification for an entity considered to be a "dependency" for a plugin metadata.

Consult the vendor for further information on how this is used.

See Also:

• Constants.VALID_ID_PATTERN

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PluginDependency.LoadOrder	Represents the ordering of how dependencies are loaded versus others.

Constructor Summary

Constructors

Constructor	Description
PluginDependency(String id, VersionRange version, PluginDependency.LoadOrder loadOrder, boolean optional)	Creates an instance of a PluginDependency record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
PluginDependency.LoadOrder	loadOrder()	Returns the value of the loadOrder record component.
boolean	optional()	Returns the value of the optional record component.
final String	toString()	Returns a string representation of this record class.
VersionRange	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

PluginDependency

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

Creates an instance of a PluginDependency record class.

Parameters:

id - the value for the id record component

version - the value for the version record component

loadOrder - the value for the loadOrder record component

optional - the value for the optional record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

version

public VersionRange version()

Returns the value of the version record component.

Returns:

the value of the version record component

loadOrder

public PluginDependency.LoadOrder loadOrder()

Returns the value of the loadOrder record component.

Returns:

the value of the loadOrder record component

optional

public boolean optional()

Returns the value of the optional record component.

Returns:

the value of the optional record component