/*
 * Copyright 2021 the original author or authors.
 *
 * Licensed 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.
 */

package org.gradle.util;

import org.gradle.api.Incubating;
import org.gradle.util.internal.DefaultGradleVersion;

/**
 * Represents a Gradle version.
 * @since 0.7
 */
public abstract class GradleVersion implements Comparable<GradleVersion> {

    /**
     * Returns the current Gradle version.
     *
     * @return The current Gradle version.
     * @since 1.0
     */
    public static GradleVersion current() {
        return DefaultGradleVersion.current();
    }

    /**
     * Parses the given string into a GradleVersion.
     *
     * @throws IllegalArgumentException On unrecognized version string.
     * @since 1.0
     */
    public static GradleVersion version(String version) throws IllegalArgumentException {
        return DefaultGradleVersion.version(version);
    }

    /**
     * Returns the string that represents this version.
     *
     * @return this Gradle version in string format.
     * @since 0.7
     */
    public abstract String getVersion();

    /**
     * Returns the major version of this Gradle version.
     * <p>
     * For example, if the version is {@code "9.3-rc-1"}, the major version is {@code 9}.
     *
     * @return The major version.
     *
     * @since 9.0.0
     */
    public abstract int getMajorVersion();

    /**
     * Returns {@code true} if this instance represent a snapshot version (e.g. 7.0-20210406233629+0000).
     *
     * @return Whether the current instance is a snapshot version
     * @since 0.9.1
     */
    public abstract boolean isSnapshot();

    /**
     * The base version of this version. For pre-release versions, this is the target version.
     *
     * For example, the version base of '7.1-rc-1' is '7.1'.
     *
     * @return The version base
     * @since 1.8
     */
    public abstract GradleVersion getBaseVersion();

    /**
     * Returns {@code true} if this version is a final release.
     *
     * @return Whether this version is a final release
     * @since 9.0.0
     */
    @Incubating
    public abstract boolean isFinal();

    @Override
    public abstract int compareTo(GradleVersion o);
}
