Module org.spongepowered.plugin.metadata

Package org.spongepowered.plugin.metadata.model

Record Class PluginConflict

java.lang.Object

java.lang.Record

org.spongepowered.plugin.metadata.model.PluginConflict

Record Components:

id - The id

version - The version, as a maven range.

fatal - Whether this conflict should prevent loading

reason - The reason

public record PluginConflict(String id, VersionRange version, boolean fatal, Optional<String> reason)
extends Record

Specification for an entity considered to be conflicting with a plugin metadata.

The vendor will either log a warning or refuse to load when this entity is present.

See Also:

• Constants.VALID_ID_PATTERN

Constructor Summary

Constructors

Constructor	Description
PluginConflict(String id, VersionRange version, boolean fatal, @Nullable String reason)
PluginConflict(String id, VersionRange version, boolean fatal, Optional<String> reason)	Creates an instance of a PluginConflict record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	fatal()	Returns the value of the fatal record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Optional<String>	reason()	Returns the value of the reason 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

PluginConflict

public PluginConflict(String id,
 VersionRange version,
 boolean fatal,
 Optional<String> reason)

Creates an instance of a PluginConflict record class.

Parameters:

id - the value for the id record component

version - the value for the version record component

fatal - the value for the fatal record component

reason - the value for the reason record component

PluginConflict

public PluginConflict(String id,
 VersionRange version,
 boolean fatal,
 @Nullable String reason)

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

fatal

public boolean fatal()

Returns the value of the fatal record component.

Returns:

the value of the fatal record component

reason

public Optional<String> reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component