Interface JPOSPluginExtension

public interface JPOSPluginExtension
Extension for the JPOSPlugin

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXCLUDED_FILES
    per target excluded files
    static final String
    NAME
    Internal plugin name

  • Method Summary

    Modifier and Type
    Method
    Description
    default Map<String,String>
    asMap()
    Converts the current properties to a map for easy access and manipulation.
    org.gradle.api.provider.Property<Boolean>
    getAddBuildTime()
    Determines if the task that adds the build time metadata should be executed.
    org.gradle.api.provider.Property<Boolean>
    getAddGitRevision()
    Determines if the task that adds the git metadata should be executed.
    org.gradle.api.provider.Property<String>
    getArchiveJarName()
    Retrieves the name of the JAR file to be built.
    org.gradle.api.provider.Property<String>
    getArchiveWarName()
    Retrieves the name of the WAR file to be placed in the distribution.
    org.gradle.api.provider.Property<String>
    getDistDir()
    Retrieves the directory that will serve as the source for the distribution.
    org.gradle.api.provider.ListProperty<String>
    getExtraPaths()
    Retrieves the list of extra paths from src/dist/ to include in distnc/zipnc tasks.
    org.gradle.api.provider.Property<String>
    getInstallDir()
    Retrieves the directory path where the artifacts will be installed.
    org.gradle.api.provider.MapProperty<String,Object>
    getProperties()
    Retrieves a map of properties that can be used internally by the plugin.
    org.gradle.api.provider.Property<String>
    getTarget()
    Retrieves the target configuration property to use.
    default void
    initConventions(org.gradle.api.Project project)
    Initializes the convention values for the plugin properties based on the given project.
    default void
    loadFromProject(org.gradle.api.Project project)
    Loads the plugin properties from the project-specific configuration file.

  • Field Details

  • Method Details

    • getTarget

      @Input org.gradle.api.provider.Property<String> getTarget()
      Retrieves the target configuration property to use.
      Returns:
      the Property representing the target configuration

    • getAddGitRevision

      @Input org.gradle.api.provider.Property<Boolean> getAddGitRevision()
      Determines if the task that adds the git metadata should be executed.
      Returns:
      the Property indicating whether to include revision.properties info in the distribution folder

    • getAddBuildTime

      @Input org.gradle.api.provider.Property<Boolean> getAddBuildTime()
      Determines if the task that adds the build time metadata should be executed.
      Returns:
      the Property indicating whether to include buildinfo.properties file in the distribution folder

    • getArchiveJarName

      @Input org.gradle.api.provider.Property<String> getArchiveJarName()
      Retrieves the name of the JAR file to be built.
      Returns:
      the Property representing the name of the archive JAR

    • getArchiveWarName

      @Input org.gradle.api.provider.Property<String> getArchiveWarName()
      Retrieves the name of the WAR file to be placed in the distribution.
      Returns:
      the Property representing the name of the archive WAR

    • getInstallDir

      @Input org.gradle.api.provider.Property<String> getInstallDir()
      Retrieves the directory path where the artifacts will be installed.
      Returns:
      the Property indicating the installation directory

    • getDistDir

      @Input org.gradle.api.provider.Property<String> getDistDir()
      Retrieves the directory that will serve as the source for the distribution.
      Returns:
      the Property indicating the source directory for the distribution

    • getExtraPaths

      @Input org.gradle.api.provider.ListProperty<String> getExtraPaths()
      Retrieves the list of extra paths from src/dist/ to include in distnc/zipnc tasks.
      Returns:
      the ListProperty of extra path names

    • getProperties

      @Internal org.gradle.api.provider.MapProperty<String,Object> getProperties()
      Retrieves a map of properties that can be used internally by the plugin.
      Returns:
      the MapProperty of internal properties

    • loadFromProject

      default void loadFromProject(org.gradle.api.Project project) throws IOException
      Loads the plugin properties from the project-specific configuration file. The configuration file name is derived from the target environment and must exist at the project root level.
      Parameters:
      project - The Gradle project from which to load properties.
      Throws:
      IOException - If there is an error reading the configuration file.

    • asMap

      default Map<String,String> asMap()
      Converts the current properties to a map for easy access and manipulation.
      Returns:
      A map representation of the current properties.

    • initConventions

      default void initConventions(org.gradle.api.Project project)
      Initializes the convention values for the plugin properties based on the given project. This sets up default values for properties such as the target environment, build time, git revision, and naming conventions for JAR and WAR archives.
      Parameters:
      project - The Gradle project whose settings will be used to initialize the conventions.