VersionConstraint.java

/*
 * 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.
 */
package org.apache.maven.api;

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.Nullable;

/**
 * Version constraint for dependency.
 * Constraint is either a range ("[1,2)") or recommended version ("1.0").
 *
 * {@code VersionConstraint} objects are created using the
 * {@linkplain org.apache.maven.api.services.VersionParser} service.
 *
 * @see Version
 * @see VersionRange
 * @see org.apache.maven.api.services.VersionParser#parseVersionConstraint(String)
 * @see org.apache.maven.api.Session#parseVersionConstraint(String)
 * @since 4.0.0
 */
@Experimental
public interface VersionConstraint {
    /**
     * Returns the range of this constraint, or {@code null} if none.
     * <p>
     * Note: only one, this method or {@link #recommendedVersion()} method must return non-{@code null} value.
     */
    @Nullable
    VersionRange versionRange();

    /**
     * Returns the range of this constraint, or {@code null} if none.
     * <p>
     * Note: only one, this method or {@link #getRecommendedVersion()} method must return non-{@code null} value.
     *
     * @deprecated Use {@link #versionRange()} instead.
     */
    @Deprecated(since = "4.1.0", forRemoval = true)
    @Nullable
    default VersionRange getVersionRange() {
        return versionRange();
    }

    /**
     * Returns the recommended version of this constraint, or {@code null} if none.
     * <p>
     * Note: only one, this method or {@link #versionRange()} method must return non-{@code null} value.
     */
    @Nullable
    Version recommendedVersion();

    /**
     * Returns the recommended version of this constraint, or {@code null} if none.
     * <p>
     * Note: only one, this method or {@link #getVersionRange()} method must return non-{@code null} value.
     *
     * @deprecated Use {@link #recommendedVersion()} instead.
     */
    @Deprecated(since = "4.1.0", forRemoval = true)
    @Nullable
    default Version getRecommendedVersion() {
        return recommendedVersion();
    }

    /**
     * Determines whether the specified version is contained within this constraint.
     *
     * @param version the version to test, must not be {@code null}
     * @return {@code true} if this range contains the specified version, {@code false} otherwise
     */
    boolean contains(@Nonnull Version version);

    /**
     * {@return the string representation of this version}
     */
    @Nonnull
    @Override
    String toString();
}