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