Module io.github.miniplaceholders.api
Package io.github.miniplaceholders.api.provider

Record Class LoadRequirement.AvailableComplementRequirement

java.lang.Object
java.lang.Record
io.github.miniplaceholders.api.provider.LoadRequirement.AvailableComplementRequirement
Record Components:
name - the main complement name
platformAliases - the complement aliases
All Implemented Interfaces:
LoadRequirement
Enclosing interface:
LoadRequirement
@Internal @NullMarked public static record LoadRequirement.AvailableComplementRequirement(String name, String[] platformAliases) extends Record implements LoadRequirement
AvailableComplementRequirement

  • Constructor Details

    • AvailableComplementRequirement

      public AvailableComplementRequirement(String name, String... platformAliases)
      Creates an instance of a AvailableComplementRequirement record class.
      Parameters:
      name - the value for the name record component
      platformAliases - the value for the platformAliases record component

  • Method Details

    • shouldLoad

      public boolean shouldLoad(Predicate<String> platformComplementTester)
      Checks if a complement is loaded
      Parameters:
      platformComplementTester - the checker predicate
      Returns:
      is this expansion should load

    • toString

      public 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

    • platformAliases

      public String[] platformAliases()
      Returns the value of the platformAliases record component.
      Returns:
      the value of the platformAliases record component