Constructor Detail

• public PluginMetadata(java.lang.String name, java.lang.String pluginVersion, java.lang.String grailsVersionRange, java.lang.Class<?> pluginClass, java.lang.String[] loadAfterNames, java.lang.String[] loadBeforeNames, java.util.Map<java.lang.String, java.lang.Object> dependencies, java.lang.String[] dependsOnNames, java.lang.String[] evictions, java.lang.String[] observedPluginNames, java.util.Map<java.lang.String, java.util.Set<java.lang.Object>> environments, boolean enabled)

  Creates plugin metadata extracted from a plugin class.

  Parameters:

  name - the logical plugin name (for example core or myPlugin)

  pluginVersion - the declared plugin version

  grailsVersionRange - the Grails version range supported by this plugin

  pluginClass - the plugin implementation class

  loadAfterNames - plugin names this plugin prefers to load after

  loadBeforeNames - plugin names this plugin prefers to load before

  dependencies - the raw declared dependency map keyed by plugin name

  dependsOnNames - plugin names this plugin depends on, used for dependency resolution

  evictions - plugin names this plugin evicts

  observedPluginNames - plugin names observed by this plugin

  environments - the environments this plugin is enabled for, or an empty map if enabled for all environments

  enabled - whether the plugin is enabled at all

Method Detail

• @java.lang.Override
  public boolean equals(java.lang.Object o)

  Compares this metadata with another metadata instance using the logical plugin name.

  Parameters:

  o - the other object to compare

  Returns:

  true if both metadata instances have the same plugin name

• public java.util.Map<java.lang.String, java.lang.Object> getDependencies()

  Returns the raw declared dependency map.

  Returns:

  the dependency map keyed by plugin name

• public java.lang.String getDependentVersion(java.lang.String name)

  Returns the declared version for the named plugin dependency.

  throws:

  PluginException if the dependency is referenced without a version

  Parameters:

  name - the dependency plugin name

  Returns:

  the declared dependency version

• public java.lang.String[] getDependsOnNames()

  Returns the plugin names this plugin depends on.

  Returns:

  the declared dependency plugin names

• public boolean getEnabled()

  Returns whether the plugin is enabled or disabled.

  Returns:

  true if the plugin is enabled

• public java.util.Map<java.lang.String, java.util.Set<java.lang.Object>> getEnvironments()

  Returns the environments in which this plugin is enabled.

  Returns:

  the configured environment include/exclude map

• public java.lang.String[] getEvictions()

  Returns the plugin names this plugin evicts.

  Returns:

  the declared evicted plugin names

• public java.lang.String getGrailsVersionRange()

  Returns the Grails version range supported by this plugin.

  Returns:

  the supported Grails version

• public java.lang.String[] getLoadAfterNames()

  Returns the plugin names this plugin prefers to load after.

  Returns:

  the declared load-after plugin names

• public java.lang.String[] getLoadBeforeNames()

  Returns the plugin names this plugin prefers to load before.

  Returns:

  the declared load-before plugin names

• public java.lang.String getName()

  Returns the logical plugin name (for example core or myPlugin).

  Returns:

  the plugin name

• public java.lang.String[] getObservedPluginNames()

  Returns the plugin names observed by this plugin.

  Returns:

  the declared observed plugin names

• public java.lang.Class<?> getPluginClass()

  Returns the plugin implementation class.

  Returns:

  the plugin class

• public java.lang.String getPluginVersion()

  Returns the declared plugin version.

  Returns:

  the plugin version

• @java.lang.Override
  public int hashCode()

• @java.lang.Override
  public java.lang.String toString()