Package grails.plugins

Interface GrailsPluginInfo

  • public interface GrailsPluginInfo
    Base interface that just contains information about a particular plugin.
    Since:
    1.3

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      The name of the plugin
      static java.lang.String TRAILING_NAME
      Defines the convention that appears within plugin class names
      static java.lang.String VERSION
      Defines the name of the property that specifies the plugin version

    • Field Detail

      • TRAILING_NAME

        static final java.lang.String TRAILING_NAME
        Defines the convention that appears within plugin class names
        See Also:
        Constant Field Values

      • VERSION

        static final java.lang.String VERSION
        Defines the name of the property that specifies the plugin version
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Returns:
        The name of the plug-in

      • getVersion

        java.lang.String getVersion()
        Returns:
        The version of the plug-in

      • getFullName

        java.lang.String getFullName()
        Returns:
        The full name of the plugin including version

      • getDescriptor

        Resource getDescriptor()
        Returns the location of the Resource that represents the plugin descriptor (the *GrailsPlugin.groovy file)
        Returns:
        The resource

      • getPluginDir

        Resource getPluginDir()
        Returns:
        The directory where the plugin exists or null if it cannot be read

      • getProperties

        java.util.Map getProperties()
        Gets the properties of the plugin as a map
        Returns:
        A map of the properties