Method Detail

• abstract Dependency dependency(Dependency dependency)

• abstract Dependency dependency(String gavNotation)

  Defines a dependency.

  Dependency name will be equal to parsed artifactId.
  Example:

   dependency('com.googlecode.guava:guava:29.0-jre')
   

  Parameters:

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency dependency(String name, String gavNotation)

  Defines a dependency.

  Example:

   dependency('guava', 'com.googlecode.guava:guava:29.0-jre')
   

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency dependency(String name, String gavNotation, Action<? super DependencySpec> action)

  Defines and configures a dependency.

  Example:

   dependency('groovy', 'org.codehaus.groovy:groovy:3.0.6') {*     modules = [
           'groovy-test',
           'groovy-json',
           'groovy-xml'
       ]
  }* 

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency dependency(String name, String gavNotation, @DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: DependencySpec) Closure<Void> action)

  Defines and configures a dependency.

  Example:

   dependency('groovy', 'org.codehaus.groovy:groovy:3.0.6') {*     modules = [
           'groovy-test',
           'groovy-json',
           'groovy-xml'
       ]
  }* 

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency dependency(String gavNotation, Action<? super DependencySpec> action)

  Defines and configures a dependency by gavNotation.

  Example:

   dependency('org.codehaus.groovy:groovy:3.0.6') {*     modules = [
           'groovy-test',
           'groovy-json',
           'groovy-xml'
       ]
  }* 

  Parameters:

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency dependency(String gavNotation, @DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: DependencySpec) Closure<Void> action)

  Defines and configures a dependency by gavNotation.

  Example:

   dependency('org.codehaus.groovy:groovy:3.0.6') {*     modules = [
           'groovy-test',
           'groovy-json',
           'groovy-xml'
       ]
  }* 

  Parameters:

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Dependency findDependency(String nameOrGa)

  Retrieves a declared dependency by name.

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the dependency to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Dependency instance when found or null.

• abstract Dependency findDependencyByGA(String groupId, String artifactId)

  Retrieves a declared dependency by grouId and artifactId.

  throws:

  IllegalArgumentException if the given groupId or artifactId are blank

  Parameters:

  groupId - the groupId of the dependency to find

  artifactId - the artifactId of the dependency to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Dependency instance when found, null otherwise.

• abstract Dependency findDependencyByName(String name)

  Retrieves a declared dependency by name.

  throws:

  IllegalArgumentException if the given name is blank

  Parameters:

  name - the logical name of the dependency to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Dependency instance when found, null otherwise.

• abstract Platform findPlatform(String nameOrGa)

  Retrieves a declared platform by name.

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the platform to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Platform instance when found or {@code null.

• abstract Platform findPlatformByGA(String groupId, String artifactId)

  Retrieves a declared platform by grouId and artifactId.

  throws:

  IllegalArgumentException if the given groupId or artifactId are blank

  Parameters:

  groupId - the groupId of the platform to find

  artifactId - the artifactId of the platform to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Platform instance when found, null otherwise.

• abstract Platform findPlatformByName(String name)

  Retrieves a declared platform by name.

  throws:

  IllegalArgumentException if the given name is blank

  Parameters:

  name - the logical name of the platform to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Platform instance when found, null otherwise.

• abstract String ga(String nameOrGa, String moduleName)

  Formats the named module dependency in groupId:artifactId notation.

  throws:

  IllegalArgumentException if the given args are blank or the named dependency is not found

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the dependency to find

  moduleName - the name of the module to find.

• abstract String gav(String nameOrGa)

  Formats the named dependency in groupId:artifactId:version notation.

  throws:

  IllegalArgumentException if the named dependency is not found

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the dependency to find

• abstract String gav(String nameOrGa, String moduleName)

  Formats the named module dependency in groupId:artifactId:version notation.

  throws:

  IllegalArgumentException if the given args are blank or the named dependency is not found

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the dependency to find

  moduleName - the name of the module to find.

• abstract Map<String, Dependency> getDependencies()

  A view of all registered dependencies and platforms, keyed by logical name. The returned view is unmodifiable.

• abstract Dependency getDependency(String nameOrGa)

  Retrieves a declared dependency by name.

  throws:

  IllegalArgumentException if the named dependency is not found

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the dependency to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Dependency instance when found.

• abstract Platform getPlatform(String nameOrGa)

  Retrieves a declared platform by name.

  throws:

  IllegalArgumentException if the named platform is not found

  Parameters:

  nameOrGa - the logical name or the groupId:artifactId of the platform to find

  Returns:

  org.kordamp.gradle.plugin.base.model.artifact.Platform instance when found.

• abstract Platform platform(String gavNotation)

  Defines a platform dependency.

  Dependency name will be equal to parsed artifactId.
  Example:

   platform('io.micronaut:micronaut-bom:2.0.2')
   

  Parameters:

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Platform platform(String name, String gavNotation)

  Defines a platform dependency.

  Example:

   platform('micronaut', 'io.micronaut:micronaut-bom:2.0.2')
   

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Platform platform(String name, String gavNotation, Action<? super PlatformSpec> action)

  Defines and configures a platform dependency.

  Example:

   platform('micronaut', 'io.micronaut:micronaut-bom:2.0.2') {*     modules = [
           'micronaut-core',
           'micronaut-inject',
           'micronaut-validation'
       ]
  }* 

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract Platform platform(String name, String gavNotation, @DelegatesTo(strategy: Closure.DELEGATE_FIRST, value: PlatformSpec) Closure<Void> action)

  Defines and configures a platform dependency.

  Example:

   platform('micronaut', 'io.micronaut:micronaut-bom:2.0.2') {*     modules = [
           'micronaut-core',
           'micronaut-inject',
           'micronaut-validation'
       ]
  }* 

  Parameters:

  name - the logical name of the dependency

  gavNotation - must be in the groupId:artifactId:version notation

• abstract void resolve()

• abstract Map<String, Collection<Object>> toMap()