Package io.github.srdjanv.localgitdependency.property

Interface CommonBuilder

All Known Subinterfaces:
DependencyBuilder, GlobalBuilder
All Known Implementing Classes:
CommonPropertyBuilder, DependencyProperty.Builder, GlobalProperty.Builder
public interface CommonBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dependencyType(Dependency.Type dependencyType)
    How the dependency is going to be added to the project
    void
    enableIdeSupport(Boolean enableIdeSupport)
    By enabling this the plugin will register the source sets, configurations, its dependencies to your project.
    void
    generateGradleTasks(Boolean generateGradleTasks)
    Custom tasks can be generated for this dependency
    void
    gitDir(File dir)
    This will set the directory in which the dependency will be created, it will not set the folder.
    void
    gitDir(String dir)
    Same as the above, but takes a string
    void
    gradleDaemonMaxIdleTime(Integer gradleDaemonMaxIdleTime)
    For how long should the gradle daemon used for dependency building idle.
    void
    javaHomeDir(File javaHomeDir)
    Some project need a specific java version to be build, specify the path of the JDK
    void
    javaHomeDir(String javaHomeDir)
    Same as the above, but takes a string
    void
    keepDependencyInitScriptUpdated(Boolean keepDependencyInitScriptUpdated)
    If set to false the generated dependencyInitScript will never be updated of fixed if changes are detected
    void
    keepGitUpdated(Boolean keepGitUpdated)
    This will try to keep the gir repo of the dependency updated
    void
    mavenDir(File mavenDir)
    Some Dependency types will publish the artifact to local maven repo.
    void
    mavenDir(String mavenDir)
    Same as the above, but takes a string
    void
    persistentDir(File persistentDir)
    This will set the directory in which the dependency data will be stored, it will not set the folder.
    void
    persistentDir(String persistentDir)
    Same as the above, but takes a string
    void
    registerDependencyRepositoryToProject(Boolean registerDependencyRepositoryToProject)
    If a repository should be added for the build dependency, this will not do anything for the Jar dependency type
    void
    tryGeneratingJavaDocJar(Boolean tryGeneratingJavaDocJar)
    If the cloned dependency doesn't have a task that is going to make a java doc jar, the plugin can try to generate one
    void
    tryGeneratingSourceJar(Boolean tryGeneratingSourceJar)
    If the cloned dependency doesn't have a task that is going to make a source jar, the plugin can try to generate one

  • Method Details

    • keepGitUpdated

      void keepGitUpdated(Boolean keepGitUpdated)
      This will try to keep the gir repo of the dependency updated
      Parameters:
      keepGitUpdated - True if the plugin should update the git repo if the target commit changes

    • keepDependencyInitScriptUpdated

      void keepDependencyInitScriptUpdated(Boolean keepDependencyInitScriptUpdated)
      If set to false the generated dependencyInitScript will never be updated of fixed if changes are detected
      Parameters:
      keepDependencyInitScriptUpdated - If it should stay updated

    • gitDir

      void gitDir(File dir)
      This will set the directory in which the dependency will be created, it will not set the folder. If you set the path to "./libs" the dependency will make a directory based of the dependency name inside the folder
      Parameters:
      dir - directory target

    • gitDir

      void gitDir(String dir)
      Same as the above, but takes a string
      Parameters:
      dir - directory target

    • javaHomeDir

      void javaHomeDir(File javaHomeDir)
      Some project need a specific java version to be build, specify the path of the JDK
      Parameters:
      javaHomeDir - Path to the JDK

    • javaHomeDir

      void javaHomeDir(String javaHomeDir)
      Same as the above, but takes a string
      Parameters:
      javaHomeDir - directory target

    • persistentDir

      void persistentDir(File persistentDir)
      This will set the directory in which the dependency data will be stored, it will not set the folder. If you set the path to "./folder" the dependency will make a directory based of the dependency name inside the folder
      Parameters:
      persistentDir - directory target

    • persistentDir

      void persistentDir(String persistentDir)
      Same as the above, but takes a string
      Parameters:
      persistentDir - directory target

    • mavenDir

      void mavenDir(File mavenDir)
      Some Dependency types will publish the artifact to local maven repo.
      Parameters:
      mavenDir - directory target
      See Also:

    • mavenDir

      void mavenDir(String mavenDir)
      Same as the above, but takes a string
      Parameters:
      mavenDir - directory target

    • dependencyType

      void dependencyType(Dependency.Type dependencyType)
      How the dependency is going to be added to the project
      Parameters:
      dependencyType - dependency target
      See Also:

    • tryGeneratingSourceJar

      void tryGeneratingSourceJar(Boolean tryGeneratingSourceJar)
      If the cloned dependency doesn't have a task that is going to make a source jar, the plugin can try to generate one
      Parameters:
      tryGeneratingSourceJar - if it should try

    • tryGeneratingJavaDocJar

      void tryGeneratingJavaDocJar(Boolean tryGeneratingJavaDocJar)
      If the cloned dependency doesn't have a task that is going to make a java doc jar, the plugin can try to generate one
      Parameters:
      tryGeneratingJavaDocJar - if it should try

    • enableIdeSupport

      void enableIdeSupport(Boolean enableIdeSupport)
      By enabling this the plugin will register the source sets, configurations, its dependencies to your project.

      Disabled by default

      Parameters:
      enableIdeSupport - if it should enable ide support

    • registerDependencyRepositoryToProject

      void registerDependencyRepositoryToProject(Boolean registerDependencyRepositoryToProject)
      If a repository should be added for the build dependency, this will not do anything for the Jar dependency type
      Parameters:
      registerDependencyRepositoryToProject - if it should register the dependency
      See Also:

    • generateGradleTasks

      void generateGradleTasks(Boolean generateGradleTasks)
      Custom tasks can be generated for this dependency
      Parameters:
      generateGradleTasks - if it should create custom tasks

    • gradleDaemonMaxIdleTime

      void gradleDaemonMaxIdleTime(Integer gradleDaemonMaxIdleTime)
      For how long should the gradle daemon used for dependency building idle. Use java's TimeUnit class for easy conversion
      Parameters:
      gradleDaemonMaxIdleTime - the amount of time in seconds
      See Also: