Module org.spongepowered.plugin.metadata
Package org.spongepowered.plugin.metadata.model

Record Class PluginContributor

java.lang.Object
java.lang.Record
org.spongepowered.plugin.metadata.model.PluginContributor
Record Components:
name - The name
description - The description or Optional.empty() otherwise
public record PluginContributor(String name, Optional<String> description) extends Record
Specification for an entity considered to be a "contributor" to a metadata or plugin metadata.

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

  • Constructor Details

    • PluginContributor

      public PluginContributor(String name, Optional<String> description)
      Creates an instance of a PluginContributor record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component

    • PluginContributor

      public PluginContributor(String name, @Nullable String description)

  • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public Optional<String> description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component