com.exasol.projectkeeper.shared.mavenprojectcrawler.CrawledMavenProject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of project-keeper-shared-model-classes Show documentation
Classes that need to be shared between different modules of project-keeper.
The newest version!
package com.exasol.projectkeeper.shared.mavenprojectcrawler;

import java.util.Objects;

import com.exasol.projectkeeper.shared.dependencies.ProjectDependencies;
import com.exasol.projectkeeper.shared.dependencychanges.DependencyChangeReport;

/**
 * Wrapper for the crawl result of maven-project-crawler for a single project.
 */
public final class CrawledMavenProject {
    private DependencyChangeReport dependencyChangeReport;
    private ProjectDependencies projectDependencies;
    private String projectVersion;
    private String javaVersion;
    private String releaseArtifactName;

    /** Default constructor required for JSON serialization. */
    public CrawledMavenProject() {
        this(null, null, null, null, null);
    }

    /**
     * Create a new instance.
     * 
     * @param dependencyChangeReport dependency change report
     * @param projectDependencies    dependencies
     * @param projectVersion         project version
     * @param javaVersion            Java version from the {@code java.version} property or {@code null} if property is
     *                               not defined
     * @param releaseArtifactName    file name of the artifact in the {@code target} directory or {@code null} if no
     *                               artifact is created
     */
    public CrawledMavenProject(final DependencyChangeReport dependencyChangeReport,
            final ProjectDependencies projectDependencies, final String projectVersion, final String javaVersion,
            final String releaseArtifactName) {
        this.dependencyChangeReport = dependencyChangeReport;
        this.projectDependencies = projectDependencies;
        this.projectVersion = projectVersion;
        this.javaVersion = javaVersion;
        this.releaseArtifactName = releaseArtifactName;
    }

    /**
     * Get dependency change report.
     * 
     * @return dependency change report
     */
    public DependencyChangeReport getDependencyChangeReport() {
        return dependencyChangeReport;
    }

    /**
     * Set dependency change report.
     * 
     * @param dependencyChangeReport dependency change report
     */
    public void setDependencyChangeReport(final DependencyChangeReport dependencyChangeReport) {
        this.dependencyChangeReport = dependencyChangeReport;
    }

    /**
     * Get dependencies.
     * 
     * @return dependencies
     */
    public ProjectDependencies getProjectDependencies() {
        return projectDependencies;
    }

    /**
     * Set dependencies.
     * 
     * @param projectDependencies dependencies
     */
    public void setProjectDependencies(final ProjectDependencies projectDependencies) {
        this.projectDependencies = projectDependencies;
    }

    /**
     * Get project version.
     * 
     * @return project version
     */
    public String getProjectVersion() {
        return projectVersion;
    }

    /**
     * Get Java version.
     * 
     * @return Java version from the {@code java.version} property or {@code null} if property is not defined
     */
    public String getJavaVersion() {
        return javaVersion;
    }

    /**
     * Set project version.
     * 
     * @param projectVersion version
     */
    public void setProjectVersion(final String projectVersion) {
        this.projectVersion = projectVersion;
    }

    /**
     * Set Java version.
     * 
     * @param javaVersion Java version from the {@code java.version} property or {@code null} if property is not defined
     */
    public void setJavaVersion(final String javaVersion) {
        this.javaVersion = javaVersion;
    }

    /**
     * Get release artifact name.
     * 
     * @return file name of the artifact in the {@code target} directory or {@code null} if no artifact is created
     */
    public String getReleaseArtifactName() {
        return releaseArtifactName;
    }

    /**
     * Set release artifact name.
     * 
     * @param releaseArtifactName file name of the artifact in the {@code target} directory or {@code null} if no
     *                            artifact is created
     */
    public void setReleaseArtifactName(final String releaseArtifactName) {
        this.releaseArtifactName = releaseArtifactName;
    }

    @Override
    public String toString() {
        return "CrawledMavenProject [dependencyChangeReport=" + dependencyChangeReport + ", projectDependencies="
                + projectDependencies + ", projectVersion=" + projectVersion + ", javaVersion=" + javaVersion
                + ", releaseArtifactName=" + releaseArtifactName + "]";
    }

    @Override
    public int hashCode() {
        return Objects.hash(dependencyChangeReport, projectDependencies, projectVersion, javaVersion,
                releaseArtifactName);
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final CrawledMavenProject other = (CrawledMavenProject) obj;
        return Objects.equals(dependencyChangeReport, other.dependencyChangeReport)
                && Objects.equals(projectDependencies, other.projectDependencies)
                && Objects.equals(projectVersion, other.projectVersion)
                && Objects.equals(javaVersion, other.javaVersion)
                && Objects.equals(releaseArtifactName, other.releaseArtifactName);
    }
}