Record Class PluginMeta

java.lang.Object
java.lang.Record
fr.fidorial.plugin.PluginMeta
Record Components:
id - the unique identifier of the plugin, also used as its command namespace
name - the human-readable name
version - the version
main - the fully qualified name of the class implementing Plugin
authors - the authors
depends - the identifiers of the plugins that must be loaded before this one
permissions - the permissions declared by the plugin, keyed by node
repositories - extra Maven repositories used to resolve the plugin libraries
public record PluginMeta(String id, String name, String version, String main, List<String> authors, List<String> depends, Map<String, PluginMeta.PermissionEntry> permissions, List<String> repositories) extends Record
The descriptor of a plugin, read from the fidorial.json file at the root of its jar.

Absent lists and maps are read as empty ones; id, name, version and main are mandatory.

Since:
0.1.0

  • Constructor Details

    • PluginMeta

      public PluginMeta(String id, String name, String version, String main, List<String> authors, List<String> depends, Map<String, PluginMeta.PermissionEntry> permissions, List<String> repositories)
      Validates the mandatory fields and copies the collections, reading absent ones as empty.
      Throws:
      IllegalArgumentException - if id, name, version or main is missing
      Since:
      0.1.0

    • PluginMeta

      public PluginMeta(String id, String name, String version, String main, List<String> authors, List<String> depends)
      Creates a descriptor declaring no permission and no repository.
      Parameters:
      id - the unique identifier of the plugin
      name - the human-readable name
      version - the version
      main - the fully qualified name of the class implementing Plugin
      authors - the authors
      depends - the identifiers of the plugins that must be loaded before this one
      Since:
      0.1.0

    • PluginMeta

      public PluginMeta(String id, String name, String version, String main, List<String> authors, List<String> depends, Map<String, PluginMeta.PermissionEntry> permissions)
      Creates a descriptor declaring no repository.
      Parameters:
      id - the unique identifier of the plugin
      name - the human-readable name
      version - the version
      main - the fully qualified name of the class implementing Plugin
      authors - the authors
      depends - the identifiers of the plugins that must be loaded before this one
      permissions - the permissions declared by the plugin, keyed by node
      Since:
      0.1.0

  • 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.

    • id

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

    • name

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

    • version

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

    • main

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

    • authors

      public List<String> authors()
      Returns the value of the authors record component.
      Returns:
      the value of the authors record component

    • depends

      public List<String> depends()
      Returns the value of the depends record component.
      Returns:
      the value of the depends record component

    • permissions

      public Map<String, PluginMeta.PermissionEntry> permissions()
      Returns the value of the permissions record component.
      Returns:
      the value of the permissions record component

    • repositories

      public List<String> repositories()
      Returns the value of the repositories record component.
      Returns:
      the value of the repositories record component