1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api;
20
21 import org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Nonnull;
23 import org.apache.maven.api.annotations.Nullable;
24
25 /**
26 * Version constraint for dependency.
27 * Constraint is either a range ("[1,2)") or recommended version ("1.0").
28 *
29 * {@code VersionConstraint} objects are created using the
30 * {@linkplain org.apache.maven.api.services.VersionParser} service.
31 *
32 * @see Version
33 * @see VersionRange
34 * @see org.apache.maven.api.services.VersionParser#parseVersionConstraint(String)
35 * @see org.apache.maven.api.Session#parseVersionConstraint(String)
36 * @since 4.0.0
37 */
38 @Experimental
39 public interface VersionConstraint {
40 /**
41 * Returns the range of this constraint, or {@code null} if none.
42 * <p>
43 * Note: only one, this method or {@link #getRecommendedVersion()} method must return non-{@code null} value.
44 */
45 @Nullable
46 VersionRange getVersionRange();
47
48 /**
49 * Returns the recommended version of this constraint, or {@code null} if none.
50 * <p>
51 * Note: only one, this method or {@link #getVersionRange()} method must return non-{@code null} value.
52 */
53 @Nullable
54 Version getRecommendedVersion();
55
56 /**
57 * Determines whether the specified version is contained within this constraint.
58 *
59 * @param version the version to test, must not be {@code null}
60 * @return {@code true} if this range contains the specified version, {@code false} otherwise
61 */
62 boolean contains(@Nonnull Version version);
63
64 /**
65 * Returns a string representation of this version constraint
66 * @return the string representation of this version constraint
67 */
68 @Nonnull
69 String asString();
70 }