org.codehaus.mojo.versions.reporting.OverviewStats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of versions-maven-plugin Show documentation
The Versions Maven Plugin is used when you want to manage the versions of artifacts in a project's POM.
The newest version!
package org.codehaus.mojo.versions.reporting;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Collection;
import java.util.Optional;

import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.codehaus.mojo.versions.api.AbstractVersionDetails;
import org.codehaus.mojo.versions.api.ArtifactVersions;
import org.codehaus.mojo.versions.api.ArtifactVersionsCache;
import org.codehaus.mojo.versions.api.Segment;

import static java.util.Optional.of;
import static org.codehaus.mojo.versions.api.Segment.INCREMENTAL;
import static org.codehaus.mojo.versions.api.Segment.MAJOR;
import static org.codehaus.mojo.versions.api.Segment.MINOR;
import static org.codehaus.mojo.versions.api.Segment.SUBINCREMENTAL;

/**
 * Represents summary stats
 *
 * @author Andrzej Jarmoniuk
 */
public class OverviewStats {
    private int major;

    private int minor;

    private int incremental;

    private int any;

    private int upToDate;

    /**
     * Creates a {@linkplain OverviewStats} instance based on the collection of version updates in
     * the argument
     *
     * @param updates collection of all version updates, typically from
     * {@linkplain org.codehaus.mojo.versions.reporting.model.DependencyUpdatesModel#getAllUpdates()}
     * @param cache if not null, cache to retrieve the version information, initialised with
     * the {@link ArtifactVersions#getNewestUpdateWithinSegment(Optional, boolean)} update information
     * @param  subclass of {@linkplain OverviewStats}
     * @param  subclass of {@linkplain ArtifactVersions}
     * @param allowSnapshots whether snapshots should be included
     * @return instance of the {@linkplain OverviewStats}
     */
    public static  T fromUpdates(
            Collection updates, ArtifactVersionsCache cache, boolean allowSnapshots) {
        OverviewStats stats = new OverviewStats();
        updates.forEach(details -> {
            if (getNewestUpdate(cache, details, of(SUBINCREMENTAL), allowSnapshots) != null) {
                stats.incrementAny();
            } else if (getNewestUpdate(cache, details, of(INCREMENTAL), allowSnapshots) != null) {
                stats.incrementIncremental();
            } else if (getNewestUpdate(cache, details, of(MINOR), allowSnapshots) != null) {
                stats.incrementMinor();
            } else if (getNewestUpdate(cache, details, of(MAJOR), allowSnapshots) != null) {
                stats.incrementMajor();
            } else {
                stats.incrementUpToDate();
            }
        });
        return (T) stats;
    }

    protected static  ArtifactVersion getNewestUpdate(
            ArtifactVersionsCache cache, V details, Optional segment, boolean allowSnapshots) {
        assert cache != null;
        return cache.get(details, segment, allowSnapshots);
    }

    public int getMajor() {
        return major;
    }

    public void incrementMajor() {
        major++;
    }

    public int getMinor() {
        return minor;
    }

    public void incrementMinor() {
        minor++;
    }

    public int getIncremental() {
        return incremental;
    }

    public void incrementIncremental() {
        incremental++;
    }

    public int getAny() {
        return any;
    }

    public void incrementAny() {
        any++;
    }

    public int getUpToDate() {
        return upToDate;
    }

    public void incrementUpToDate() {
        upToDate++;
    }
}