netflix.nebula.dependency.recommender.RecommendationStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nebula-dependency-recommender Show documentation

Allows projects to leave off version numbers in dependencies section and have versions recommended by other sources

The newest version!

package netflix.nebula.dependency.recommender;

import org.gradle.api.artifacts.Dependency;
import org.gradle.api.artifacts.DependencyResolveDetails;
import org.gradle.api.artifacts.ModuleVersionSelector;

/**
 * Defines in which cases recommendations are applied
 */
public abstract class RecommendationStrategy {
    
    /**
     * This hook is called for each dependency in a project. It collects the dependencies we are interested in for determining if a recommendation should be applied.
     * @param dependency the dependency to inspect.
     */
    public abstract void inspectDependency(Dependency dependency);

    /**
     * Puts the recommended version on details.useVersion depending on the strategy used
     * @param details the details to recommend a version for
     * @param version the version to be potentially recommended for the requested artifact
     * @return true if a version has been recommended, false otherwise
     */
    public abstract boolean recommendVersion(DependencyResolveDetails details, String version);

    /**
     * Determines whether {@link #recommendVersion(DependencyResolveDetails, String)} will recommend a version,
     * given a {@link ModuleVersionSelector}
     * @param selector the selector
     * @return true if a version will be recommended
     */
    public abstract boolean canRecommendVersion(ModuleVersionSelector selector);

    /**
     * @param details the details to get coordinates from
     * @return the coordinates in the form of "<group>:<name>", taken from details.requested.
     */
    protected String getCoord(DependencyResolveDetails details) {
        ModuleVersionSelector requested = details.getRequested();
        return requested.getGroup() + ":" + requested.getName();
    }

    /**
     * @param selector the selector to get coordinates from
     * @return the coordinates in the form of "<group>:<name>"
     */
    protected String getCoord(ModuleVersionSelector selector) {
        return selector.getGroup() + ":" + selector.getName();
    }
}