Class PluginMetadata

java.lang.Object
com.blueriq.component.api.plugin.PluginMetadata
All Implemented Interfaces:
IPluginMetadata, Serializable
public class PluginMetadata extends Object implements IPluginMetadata, Serializable
Class for reading plugin meta data from a properties file.
Since:
8.1
Author:
Danny Roest
See Also:

  • Constructor Details

    • PluginMetadata

      public PluginMetadata(String pluginArtifact)
      Creates a new PluginMetadata instance for the plugin artifact by reading "[pluginArtifact].plugin" from the classpath.
      Parameters:
      pluginArtifact - the name of the artifact.

    • PluginMetadata

      public PluginMetadata(Properties properties)
      Creates a new PluginMetadata instance for the plugin with the specified properties.
      Parameters:
      properties - the properties containing the metadata.

  • Method Details

    • getProperties

      public Properties getProperties()
      This method returns the properties where this metadata is based on.
      Returns:
      the properties where this metadata is based on.

    • getGroupId

      public String getGroupId()
      Description copied from interface: IPluginMetadata
      This method returns the groupId of the plugin.
      Specified by:
      getGroupId in interface IPluginMetadata
      Returns:
      the GroupId

    • getName

      public String getName()
      Description copied from interface: IPluginMetadata
      This method returns the name of the plugin.
      Specified by:
      getName in interface IPluginMetadata
      Returns:
      the name of the plugin

    • getDescription

      public String getDescription()
      Description copied from interface: IPluginMetadata
      This method returns the description of the plugin.
      Specified by:
      getDescription in interface IPluginMetadata
      Returns:
      the description of this plugin.

    • getVersion

      public PluginVersion getVersion()
      Description copied from interface: IPluginMetadata
      This method returns the version the plugin.
      Specified by:
      getVersion in interface IPluginMetadata
      Returns:
      the version of the plugin.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getArtifactId

      public String getArtifactId()
      Description copied from interface: IPluginMetadata
      This method returns the artifactId.
      Specified by:
      getArtifactId in interface IPluginMetadata
      Returns:
      the artifactId

    • getUrl

      public String getUrl()
      Description copied from interface: IPluginMetadata
      This method returns the url for more information about the plugin.
      Specified by:
      getUrl in interface IPluginMetadata
      Returns:
      the url, may be null.