org.netbeans.modules.gradle.api

Class GradleConfiguration

java.lang.Object

org.netbeans.modules.gradle.api.GradleConfiguration

All Implemented Interfaces:

Serializable, Comparable<GradleConfiguration>, ModuleSearchSupport

public final class GradleConfiguration
extends Object
implements Serializable, ModuleSearchSupport, Comparable<GradleConfiguration>

This object represents a configuration in a Gradle project.

Since:

1.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(GradleConfiguration o)
Set<GradleDependency.ModuleDependency>	findModules(String gav) Search for module dependencies, matches the given filter criteria.
Set<GradleDependency.ModuleDependency>	findModules(String group, String artifact, String version) Search for module dependencies, matches the given filter criteria.
Set<GradleConfiguration>	getAllParents()
Map<String,String>	getAttributes() Returns the attributes of this configuration.
Collection<? extends GradleDependency>	getConfiguredDependencies() Returns set of dependencies configured for this configuration directly.
Collection<GradleDependency>	getDependencies()
Collection<GradleDependency>	getDependenciesOf(GradleDependency... path)
GradleConfiguration	getDependencyOrigin(GradleDependency d) Determines the origin of a given dependency.
String	getDescription()
Set<GradleConfiguration>	getExtendsFrom()
GradleDependency.FileCollectionDependency	getFiles()
Set<GradleDependency.ModuleDependency>	getModules()
String	getName()
Set<GradleDependency.ProjectDependency>	getProjects()
Set<GradleDependency.UnresolvedDependency>	getUnresolved()
boolean	isCanBeConsumed() Returns true if this configuration is to be consumed.
boolean	isCanBeResolved()
boolean	isEmpty()
boolean	isResolved()
boolean	isTransitive()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getModules

public Set<GradleDependency.ModuleDependency> getModules()

getName

public String getName()

getDescription

public String getDescription()

getProjects

public Set<GradleDependency.ProjectDependency> getProjects()

getUnresolved

public Set<GradleDependency.UnresolvedDependency> getUnresolved()

getExtendsFrom

public Set<GradleConfiguration> getExtendsFrom()

getConfiguredDependencies

public Collection<? extends GradleDependency> getConfiguredDependencies()

Returns set of dependencies configured for this configuration directly. Other (direct) dependencies may be supplied by GradleConfiguration.getExtendsFrom() configurations.

Returns:

direct dependencies

getDependencyOrigin

public GradleConfiguration getDependencyOrigin(GradleDependency d)

Determines the origin of a given dependency. This works only for direct dependencies (see GradleConfiguration.getDependencies() - as a dependency can be present more than once in a dependency tree graph introduced by different intermediates in different configurations.

The method retuns null if the origin cannot be determined.

Parameters:

d - dependency to inspect

Returns:

configuration of origin or null.

getDependencies

public Collection<GradleDependency> getDependencies()

getDependenciesOf

public Collection<GradleDependency> getDependenciesOf(GradleDependency... path)

findModules

public Set<GradleDependency.ModuleDependency> findModules(String group,
                                                          String artifact,
                                                          String version)

Description copied from interface: ModuleSearchSupport

Search for module dependencies, matches the given filter criteria. Specifying null for any of the parameters would mean match all for that parameter.

Specified by:

findModules in interface ModuleSearchSupport

Parameters:

group - regexp matcher for the group part.

artifact - regexp matcher for the artifact part.

version - regexp matcher for the version part.

Returns:

Set of module dependencies that match the criteria.

See Also:

Pattern

findModules

public Set<GradleDependency.ModuleDependency> findModules(String gav)

Description copied from interface: ModuleSearchSupport

Search for module dependencies, matches the given filter criteria. The format of the criteria is a colon separated string: "<group>:<atrifact>:<version>", empty pattern mean match all for that part.

Specified by:

findModules in interface ModuleSearchSupport

Parameters:

gav - the filter criteria in string form

Returns:

Set of module dependencies that match the criteria.

See Also:

ModuleSearchSupport.findModules(java.lang.String, java.lang.String, java.lang.String)

getAllParents

public Set<GradleConfiguration> getAllParents()

getFiles

public GradleDependency.FileCollectionDependency getFiles()

isResolved

public boolean isResolved()

isTransitive

public boolean isTransitive()

isCanBeResolved

public boolean isCanBeResolved()

isCanBeConsumed

public boolean isCanBeConsumed()

Returns true if this configuration is to be consumed.

Returns:

true if this configuration is consumable.

Since:

2.24

getAttributes

public Map<String,String> getAttributes()

Returns the attributes of this configuration. The returned map is a simplified version of the Gradle configuration AttributeContainer, where the attribute names are the keys and the attribute string values are the values.

Returns:

the attributes of this configuration

Since:

2.24

isEmpty

public boolean isEmpty()

compareTo

public int compareTo(GradleConfiguration o)

Specified by:

compareTo in interface Comparable<GradleConfiguration>

toString

public String toString()

Overrides:

toString in class Object