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 * A range of versions.
27 *
28 * {@code VersionConstraint} objects are created using the
29 * {@linkplain org.apache.maven.api.services.VersionParser} service.
30 *
31 * @see Version
32 * @see VersionConstraint
33 * @see org.apache.maven.api.services.VersionParser#parseVersionRange(String)
34 * @see org.apache.maven.api.Session#parseVersionRange(String)
35 * @since 4.0.0
36 */
37 @Experimental
38 public interface VersionRange {
39 /**
40 * Determines whether the specified version is contained within this range.
41 *
42 * @param version the version to test, must not be {@code null}
43 * @return {@code true} if this range contains the specified version, {@code false} otherwise
44 */
45 boolean contains(@Nonnull Version version);
46
47 /**
48 * Returns the upper boundary of this range, or {@code null} if none.
49 */
50 @Nullable
51 Boundary getUpperBoundary();
52
53 /**
54 * Returns the lower boundary of this range, or {@code null} if none.
55 */
56 @Nullable
57 Boundary getLowerBoundary();
58
59 /**
60 * Returns a string representation of this version range
61 * @return the string representation of this version range
62 */
63 @Nonnull
64 String asString();
65
66 /**
67 * Represents range boundary.
68 */
69 interface Boundary {
70 /**
71 * The bounding version.
72 */
73 Version getVersion();
74
75 /**
76 * Returns {@code true} if version is included of the range.
77 */
78 boolean isInclusive();
79 }
80 }