• Home
• org.apache.maven
• maven-api-metadata
• 4.0.0-beta-5
• source code
• Versioning.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.apache.maven.api.metadata.Versioning Maven / Gradle / Ivy

// =================== DO NOT EDIT THIS FILE ====================
//  Generated by Modello Velocity from model.vm
//  template, any modifications will be overwritten.
// ==============================================================
package org.apache.maven.api.metadata;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Generated;
import org.apache.maven.api.annotations.Immutable;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.NotThreadSafe;
import org.apache.maven.api.annotations.ThreadSafe;

/**
 * Versioning information for "groupId/artifactId" or "groupId/artifactId/version" SNAPSHOT
 */
@Experimental
@Generated @ThreadSafe @Immutable
public class Versioning
    implements Serializable
{
    /**
     * What the last version added to the directory is, including both releases and snapshots ("groupId/artifactId" directory only)
     */
    final String latest;
    /**
     * What the last version added to the directory is, for the releases only ("groupId/artifactId" directory only)
     */
    final String release;
    /**
     * Versions available of the artifact (both releases and snapshots) ("groupId/artifactId" directory only)
     */
    final List versions;
    /**
     * When the metadata was last updated (both "groupId/artifactId" and "groupId/artifactId/version" directories). The timestamp is expressed using UTC in the format yyyyMMddHHmmss.
     */
    final String lastUpdated;
    /**
     * The current snapshot data in use for this version ("groupId/artifactId/version" only)
     */
    final Snapshot snapshot;
    /**
     * Information for each sub-artifact available in this artifact snapshot. This is only the most recent SNAPSHOT for each unique extension/classifier combination.
     */
    final List snapshotVersions;

    /**
      * Constructor for this class, to be called from its subclasses and {@link Builder}.
      * @see Builder#build()
      */
    protected Versioning(Builder builder) {
        this.latest = builder.latest != null ? builder.latest : (builder.base != null ? builder.base.latest : null);
        this.release = builder.release != null ? builder.release : (builder.base != null ? builder.base.release : null);
        this.versions = ImmutableCollections.copy(builder.versions != null ? builder.versions : (builder.base != null ? builder.base.versions : null));
        this.lastUpdated = builder.lastUpdated != null ? builder.lastUpdated : (builder.base != null ? builder.base.lastUpdated : null);
        this.snapshot = builder.snapshot != null ? builder.snapshot : (builder.base != null ? builder.base.snapshot : null);
        this.snapshotVersions = ImmutableCollections.copy(builder.snapshotVersions != null ? builder.snapshotVersions : (builder.base != null ? builder.base.snapshotVersions : null));
    }

    /**
     * What the last version added to the directory is, including both releases and snapshots ("groupId/artifactId" directory only)
     *
     * @return a {@code String}
     */
    public String getLatest() {
        return this.latest;
    }

    /**
     * What the last version added to the directory is, for the releases only ("groupId/artifactId" directory only)
     *
     * @return a {@code String}
     */
    public String getRelease() {
        return this.release;
    }

    /**
     * Versions available of the artifact (both releases and snapshots) ("groupId/artifactId" directory only)
     *
     * @return a {@code List}
     */
    @Nonnull
    public List getVersions() {
        return this.versions;
    }

    /**
     * When the metadata was last updated (both "groupId/artifactId" and "groupId/artifactId/version" directories). The timestamp is expressed using UTC in the format yyyyMMddHHmmss.
     *
     * @return a {@code String}
     */
    public String getLastUpdated() {
        return this.lastUpdated;
    }

    /**
     * The current snapshot data in use for this version ("groupId/artifactId/version" only)
     *
     * @return a {@code Snapshot}
     */
    public Snapshot getSnapshot() {
        return this.snapshot;
    }

    /**
     * Information for each sub-artifact available in this artifact snapshot. This is only the most recent SNAPSHOT for each unique extension/classifier combination.
     *
     * @return a {@code List}
     */
    @Nonnull
    public List getSnapshotVersions() {
        return this.snapshotVersions;
    }

    /**
     * Creates a new builder with this object as the basis.
     *
     * @return a {@code Builder}
     */
    @Nonnull
    public Builder with() {
        return newBuilder(this);
    }
    /**
     * Creates a new {@code Versioning} instance using the specified latest.
     *
     * @param latest the new {@code String} to use
     * @return a {@code Versioning} with the specified latest
     */
    @Nonnull
    public Versioning withLatest(String latest) {
        return newBuilder(this, true).latest(latest).build();
    }
    /**
     * Creates a new {@code Versioning} instance using the specified release.
     *
     * @param release the new {@code String} to use
     * @return a {@code Versioning} with the specified release
     */
    @Nonnull
    public Versioning withRelease(String release) {
        return newBuilder(this, true).release(release).build();
    }
    /**
     * Creates a new {@code Versioning} instance using the specified versions.
     *
     * @param versions the new {@code Collection} to use
     * @return a {@code Versioning} with the specified versions
     */
    @Nonnull
    public Versioning withVersions(Collection versions) {
        return newBuilder(this, true).versions(versions).build();
    }
    /**
     * Creates a new {@code Versioning} instance using the specified lastUpdated.
     *
     * @param lastUpdated the new {@code String} to use
     * @return a {@code Versioning} with the specified lastUpdated
     */
    @Nonnull
    public Versioning withLastUpdated(String lastUpdated) {
        return newBuilder(this, true).lastUpdated(lastUpdated).build();
    }
    /**
     * Creates a new {@code Versioning} instance using the specified snapshot.
     *
     * @param snapshot the new {@code Snapshot} to use
     * @return a {@code Versioning} with the specified snapshot
     */
    @Nonnull
    public Versioning withSnapshot(Snapshot snapshot) {
        return newBuilder(this, true).snapshot(snapshot).build();
    }
    /**
     * Creates a new {@code Versioning} instance using the specified snapshotVersions.
     *
     * @param snapshotVersions the new {@code Collection} to use
     * @return a {@code Versioning} with the specified snapshotVersions
     */
    @Nonnull
    public Versioning withSnapshotVersions(Collection snapshotVersions) {
        return newBuilder(this, true).snapshotVersions(snapshotVersions).build();
    }

    /**
     * Creates a new {@code Versioning} instance.
     * Equivalent to {@code newInstance(true)}.
     * @see #newInstance(boolean)
     *
     * @return a new {@code Versioning}
     */
    @Nonnull
    public static Versioning newInstance() {
        return newInstance(true);
    }

    /**
     * Creates a new {@code Versioning} instance using default values or not.
     * Equivalent to {@code newBuilder(withDefaults).build()}.
     *
     * @param withDefaults the boolean indicating whether default values should be used
     * @return a new {@code Versioning}
     */
    @Nonnull
    public static Versioning newInstance(boolean withDefaults) {
        return newBuilder(withDefaults).build();
    }

    /**
     * Creates a new {@code Versioning} builder instance.
     * Equivalent to {@code newBuilder(true)}.
     * @see #newBuilder(boolean)
     *
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder() {
        return newBuilder(true);
    }

    /**
     * Creates a new {@code Versioning} builder instance using default values or not.
     *
     * @param withDefaults the boolean indicating whether default values should be used
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(boolean withDefaults) {
        return new Builder(withDefaults);
    }

    /**
     * Creates a new {@code Versioning} builder instance using the specified object as a basis.
     * Equivalent to {@code newBuilder(from, false)}.
     *
     * @param from the {@code Versioning} instance to use as a basis
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(Versioning from) {
        return newBuilder(from, false);
    }

    /**
     * Creates a new {@code Versioning} builder instance using the specified object as a basis.
     *
     * @param from the {@code Versioning} instance to use as a basis
     * @param forceCopy the boolean indicating if a copy should be forced
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(Versioning from, boolean forceCopy) {
        return new Builder(from, forceCopy);
    }

    /**
     * Builder class used to create Versioning instances.
     * @see #with()
     * @see #newBuilder()
     */
    @NotThreadSafe
    public static class Builder
    {
        Versioning base;
        String latest;
        String release;
        Collection versions;
        String lastUpdated;
        Snapshot snapshot;
        Collection snapshotVersions;

        protected Builder(boolean withDefaults) {
            if (withDefaults) {
            }
        }

        protected Builder(Versioning base, boolean forceCopy) {
            if (forceCopy) {
                this.latest = base.latest;
                this.release = base.release;
                this.versions = base.versions;
                this.lastUpdated = base.lastUpdated;
                this.snapshot = base.snapshot;
                this.snapshotVersions = base.snapshotVersions;
            } else {
                this.base = base;
            }
        }

        @Nonnull
        public Builder latest(String latest) {
            this.latest = latest;
            return this;
        }

        @Nonnull
        public Builder release(String release) {
            this.release = release;
            return this;
        }

        @Nonnull
        public Builder versions(Collection versions) {
            this.versions = versions;
            return this;
        }

        @Nonnull
        public Builder lastUpdated(String lastUpdated) {
            this.lastUpdated = lastUpdated;
            return this;
        }

        @Nonnull
        public Builder snapshot(Snapshot snapshot) {
            this.snapshot = snapshot;
            return this;
        }

        @Nonnull
        public Builder snapshotVersions(Collection snapshotVersions) {
            this.snapshotVersions = snapshotVersions;
            return this;
        }


        @Nonnull
        public Versioning build() {
            // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
            if (base != null
                    && (latest == null || latest == base.latest)
                    && (release == null || release == base.release)
                    && (versions == null || versions == base.versions)
                    && (lastUpdated == null || lastUpdated == base.lastUpdated)
                    && (snapshot == null || snapshot == base.snapshot)
                    && (snapshotVersions == null || snapshotVersions == base.snapshotVersions)
            ) {
                return base;
            }
            return new Versioning(this);
        }
    }

}