org.codehaus.mojo.license.api

Interface MavenProjectDependenciesConfigurator

All Known Implementing Classes:

AbstractDownloadLicensesMojo, AbstractThirdPartyReportMojo, AddThirdPartyMojo, AggregateDownloadLicensesMojo, AggregatorThirdPartyReportMojo, DownloadLicensesMojo, ThirdPartyReportMojo

public interface MavenProjectDependenciesConfigurator

Contract to configure which dependencies will be loaded by the dependency tool via the method DependenciesTool.loadProjectDependencies(org.apache.maven.project.MavenProject, MavenProjectDependenciesConfigurator, org.apache.maven.artifact.repository.ArtifactRepository, List, java.util.SortedMap)

Since:

1.0

Author:

tchemit dev@tchemit.fr

See Also:

DependenciesTool

Method Summary

Modifier and Type	Method and Description
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
boolean	isExcludeTransitiveDependencies()
boolean	isIncludeTransitiveDependencies()
boolean	isVerbose()

Method Detail

isIncludeTransitiveDependencies

boolean isIncludeTransitiveDependencies()

Returns:

true if should include transitive dependencies, false to include only direct dependencies.

isExcludeTransitiveDependencies

boolean isExcludeTransitiveDependencies()

Returns:

true if should exclude transitive dependencies from excluded artifacts, else false.

getIncludedScopes

List<String> getIncludedScopes()

Returns:

list of scopes to include while loading dependencies, if null is setted, then include all scopes.

getExcludedScopes

List<String> getExcludedScopes()

Returns:

list of scopes to exclude while loading dependencies, if null is setted, then include all scopes.

getIncludedArtifacts

String getIncludedArtifacts()

Returns:

a pattern to include dependencies by thier artificatId, if null is setted then include all artifacts.

getIncludedGroups

String getIncludedGroups()

Returns:

a pattern to include dependencies by their groupId, if null is setted then include all artifacts.

getExcludedGroups

String getExcludedGroups()

Returns:

a pattern to exclude dependencies by their artifactId, if null is setted the no exclude is done on artifactId.

getExcludedArtifacts

String getExcludedArtifacts()

Returns:

a pattern to exclude dependencies by their groupId, if null is setted then no exclude is done on groupId.

isVerbose

boolean isVerbose()

Returns:

true if verbose mode is on, false otherwise.