Package org.openrewrite.gradle.marker

Class GradleProject

java.lang.Object

org.openrewrite.gradle.marker.GradleProject

All Implemented Interfaces:

Serializable, org.openrewrite.marker.Marker

public class GradleProject
extends Object
implements org.openrewrite.marker.Marker, Serializable

Contains metadata about a Gradle Project. Queried from Gradle itself when the OpenRewrite build plugin runs. Not automatically available on LSTs that aren't parsed through a Gradle plugin, so tests won't automatically have access to this metadata.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GradleProject()

Method Summary

Modifier and Type	Method	Description
List<GradleDependencyConfiguration>	configurationsExtendingFrom(GradleDependencyConfiguration parentConfiguration, boolean transitive)	List the configurations which extend from the given configuration.
static GradleProject	fromToolingModel(GradleProject project)
@Nullable GradleDependencyConfiguration	getConfiguration(String name)
List<GradleDependencyConfiguration>	getConfigurations()
List<org.openrewrite.maven.tree.MavenRepository>	getMavenPluginRepositories()
GradleProject	withNameToConfiguration(Map<String,GradleDependencyConfiguration> nameToConfiguration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openrewrite.marker.Marker

getId, print, withId

Constructor Details

GradleProject

public GradleProject()

Method Details

getMavenPluginRepositories

public List<org.openrewrite.maven.tree.MavenRepository> getMavenPluginRepositories()

getConfiguration

@Nullable
public @Nullable GradleDependencyConfiguration getConfiguration(String name)

getConfigurations

public List<GradleDependencyConfiguration> getConfigurations()

configurationsExtendingFrom

public List<GradleDependencyConfiguration> configurationsExtendingFrom(GradleDependencyConfiguration parentConfiguration,
 boolean transitive)

List the configurations which extend from the given configuration. Assuming a hierarchy like:

     implementation
     |> compileClasspath
     |> runtimeClasspath
     |> testImplementation
        |> testCompileClasspath
        |> testRuntimeClasspath
 

When querying "implementation" with transitive is false this function will return [compileClasspath, runtimeClasspath, testImplementation]. When transitive is true this function will also return [testCompileClasspath, testRuntimeClasspath].

withNameToConfiguration

public GradleProject withNameToConfiguration(Map<String,GradleDependencyConfiguration> nameToConfiguration)

fromToolingModel

public static GradleProject fromToolingModel(GradleProject project)