org.sonar.updatecenter.common.Release.java Source code

Introduction

Here is the source code for org.sonar.updatecenter.common.Release.java

Source

/*
 * SonarSource :: Update Center :: Common
 * Copyright (C) 2010 SonarSource
 * dev@sonar.codehaus.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.updatecenter.common;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Iterables;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.ToStringBuilder;

import javax.annotation.Nullable;

import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.Set;
import java.util.SortedSet;

import static com.google.common.collect.Sets.newHashSet;
import static com.google.common.collect.Sets.newTreeSet;

public class Release implements Comparable<Release> {

    private Artifact artifact;
    private Version version;
    private String description;
    private String downloadUrl;
    private String changelogUrl;
    private boolean isPublic;
    private boolean isArchived;
    private String groupId;
    private String artifactId;

    private Release parent;
    private Set<Release> children;
    private Set<Release> outgoingDependencies;
    private Set<Release> incomingDependencies;
    /**
     * from oldest to newest sonar versions
     */
    private SortedSet<Version> compatibleSqVersions;
    private Date date;

    public Release(Artifact artifact, Version version) {
        this.artifact = artifact;
        this.version = version;
        this.isPublic = true;
        this.isArchived = false;

        this.compatibleSqVersions = newTreeSet();
        this.children = newHashSet();
        this.outgoingDependencies = newHashSet();
        this.incomingDependencies = newHashSet();
    }

    public Release(Artifact artifact, String version) {
        this(artifact, Version.create(version));
    }

    public Artifact getArtifact() {
        return artifact;
    }

    public Version getVersion() {
        return version;
    }

    public Release setVersion(Version version) {
        this.version = version;
        return this;
    }

    public String getDownloadUrl() {
        return downloadUrl;
    }

    public Release setDownloadUrl(String s) {
        this.downloadUrl = s;
        return this;
    }

    public String getFilename() {
        return StringUtils.substringAfterLast(downloadUrl, "/");
    }

    public SortedSet<Version> getRequiredSonarVersions() {
        return compatibleSqVersions;
    }

    public boolean supportSonarVersion(Version providedSqVersion) {
        // Compare versions without qualifier
        for (Version sqVersion : compatibleSqVersions) {
            if (sqVersion.isCompatibleWith(providedSqVersion)) {
                return true;
            }
        }
        return false;
    }

    public Release addRequiredSonarVersions(Version... versions) {
        if (versions != null) {
            compatibleSqVersions.addAll(Arrays.asList(versions));
        }
        return this;
    }

    public Release addRequiredSonarVersions(String... versions) {
        if (versions != null) {
            for (String v : versions) {
                compatibleSqVersions.add(Version.create(v));
            }
        }
        return this;
    }

    public Version getLastRequiredSonarVersion() {
        if (!compatibleSqVersions.isEmpty()) {
            return compatibleSqVersions.last();
        }
        return null;
    }

    public Version getMinimumRequiredSonarVersion() {
        if (!compatibleSqVersions.isEmpty()) {
            return compatibleSqVersions.first();
        }
        return null;
    }

    public Date getDate() {
        return date != null ? new Date(date.getTime()) : null;
    }

    public Release setDate(Date date) {
        this.date = date != null ? new Date(date.getTime()) : null;
        return this;
    }

    public String getDescription() {
        return description;
    }

    public Release setDescription(String description) {
        this.description = description;
        return this;
    }

    public String getChangelogUrl() {
        return changelogUrl;
    }

    public Release setChangelogUrl(String changelogUrl) {
        this.changelogUrl = changelogUrl;
        return this;
    }

    public Release getParent() {
        return parent;
    }

    public Release setParent(Release parent) {
        this.parent = parent;
        return this;
    }

    public Collection<Release> getChildren() {
        return children;
    }

    public Release addChild(Release release) {
        children.add(release);
        return this;
    }

    @Nullable
    @VisibleForTesting
    Release getChild(final String key) {
        return Iterables.find(children, new Predicate<Release>() {
            public boolean apply(Release input) {
                return input.getArtifact().getKey().equals(key);
            }
        }, null);
    }

    public Set<Release> getOutgoingDependencies() {
        return ImmutableSortedSet.copyOf(outgoingDependencies);
    }

    public Release addOutgoingDependency(Release required) {
        outgoingDependencies.add(required);
        return this;
    }

    public Set<Release> getIncomingDependencies() {
        return ImmutableSortedSet.copyOf(incomingDependencies);
    }

    public Release addIncomingDependency(Release required) {
        incomingDependencies.add(required);
        return this;
    }

    public boolean isMaster() {
        return getParent() == null;
    }

    public String getKey() {
        return getArtifact().getKey();
    }

    public Version getAdjustedVersion() {
        return version.removeQualifier();
    }

    public boolean isPublic() {
        return isPublic;
    }

    public void setPublic(boolean isPublic) {
        this.isPublic = isPublic;
    }

    public boolean isArchived() {
        return isArchived;
    }

    public void setArchived(boolean isArchived) {
        this.isArchived = isArchived;
    }

    public String groupId() {
        return groupId;
    }

    public void setGroupId(String groupId) {
        this.groupId = groupId;
    }

    public String artifactId() {
        return artifactId;
    }

    public void setArtifactId(String artifactId) {
        this.artifactId = artifactId;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Release release = (Release) o;

        if (!artifact.equals(release.artifact)) {
            return false;
        }
        if (!version.equals(release.version)) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode() {
        int result = artifact.hashCode();
        result = 31 * result + version.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this).append("version", version).append("downloadUrl", downloadUrl)
                .append("changelogUrl", changelogUrl).append("description", description).toString();
    }

    public int compareTo(Release o) {
        return getVersion().compareTo(o.getVersion());
    }
}